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.
These instructions will allow you to get a copy of the project running on your local machine for development and testing purposes.
To run the Backend system, you will need to have Node JS installed.
You can do this accessing this link.
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-front.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:
VITE_API=<The URL that will be used to run the application>
Perhaps dependencies such as vite and dotenv 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>
Execute in developer environment:
npm run dev
The main technologies used were:
- Vue - The JavaScript framework used
- Element-Plus - A Vue framework
- npm - Dependency Manager
- Axios - JavaScript library
Here is the team of UI designers and developers of the project, also responsible for idealizing and creating it.
@alinebmr Aline Brito |
@danieleolivs Daniele Oliveira |
@Paulo-Lunguinho Paulo Lunguinho |
@FLuiz22 Filipe Luiz |
@gabysouzz Gabrielly Lima |
@maahog Maria Clara |
@mateusmf4 Mateus Faria |
The project uses the GNU General Public License, please refer to the file to learn more.