🗺 UF Road

The UF Road is a system that allows the visualization of the curriculum at UFCG (Federal University of Campina Grande), aiming to assist in viewing courses and course flowcharts. The project started with the change in the Computer Science curriculum, which takes effect from the 2023.2 period. It is a collaborative community, allowing users to create profiles for contributing materials with other students, as well as keeping a record of their progress during their academic life.

🚀 Starting

These instructions will allow you to get a copy of the project running on your local machine for development and testing purposes.

📋 Prerequisites

To run the Backend system, you will need to have Node JS installed.

You can do this accessing this link.

🔧 Installation

To install, you will need to clone the project, install the dependencies, create a .env file in the project root and add the necessary variables.

First, to clone the project, run:

git clone https://github.com/FLuiz22/ufroad-api.git

At the project root, install the dependencies by running:

npm install

Also in the project root, add a ".env" file and insert the following variables:

BD_PROD=<developer database link (MongoDB Atlas)>
BD_DEV=<production database link (MongoDB Atlas)>

PORT=<port on which you want to run the API. Ex: 4444>

JWT_SECRET=<jwt password>

Perhaps dependencies such as cors, dotenv, express, jsonwebtoken and/or mongoose inform you that they need to be installed globally (on your machine).

To do so, just listen to the following commands:

node i -g <dependence>

✅ Running the System

Execute in developer environment:

npm run dev

🛠️ Built with

The main technologies used were:

• express - The API used
• npm - Dependency Manager
• mongoose - Mongodb object modeling

📌 Versions

• Sprint 1 - Connection between the API with MongoDB and creation of the User, Course, Discipline and Curriculum modules.
• Sprint 2 - Creating middleware, adding styling patterns, refactoring modules and changing .env.template documentation.
• Sprint 3 -

✒️ Authors

Here is the team of UI designers and developers of the project, also responsible for idealizing and creating it.

🎨 UI Designers & Developers

@alinebmr Aline Brito

@danieleolivs Daniele Oliveira

@Paulo-Lunguinho Paulo Lunguinho

🖥️ Developers

@FLuiz22 Filipe Luiz

@gabysouzz Gabrielly Lima

@maahog Maria Clara

@mateusmf4 Mateus Faria

📋 License

The project uses the GNU General Public License, please refer to the file to learn more.