fluxogramas-interativos-ufsj.vercel.app

           

 

    

 

💡 Motivation

The goal of this project is to standardize the presentation of all courses at UFSJ ( Universidade Federal de São João del Rei ) in an interactive way.

Currently, each course coordinator uses different methods to display course information, such as flowcharts and tables. However, this lack of consistency can be confusing for students.

By creating a standardized approach, this project aims to enhance the accessibility and clarity of course information, making it easier for students to understand their curriculum and plan their academic journey.

 

✨ Features

Front-End (React)

• ✅ Interactive progess
• 💾 Auto saving
• 🖼️ Generate image
• 📱 Responsive layout
• 🌙 Light/Dark mode

Back-End (Express)

• ♻️ CRUD operations
• 🔐 Login management using refresh tokens
• 🗃️ Data stored using PostgreSQL (Neon cluster)

 

🛠️ Project Management

This project is maintened by gabriel-dp, if you want to contribute in any way, get in touch with me!

Publishing data of all courses will take a significant amount of time as it will be added gradually. 😅

 

---

 

🖥️ Run locally

Clone repository

git clone https://github.com/gabriel-dp/Fluxogramas-Interativos-UFSJ.git
cd Fluxogramas-Interativos-UFSJ

Install dependencies

npm install

Define environment variables

View and fill server and client .env examples. Follow the instructions of the README files.

Run client, server and database

You must have Docker installed.

npm run docker:up

Use the most recent SQL dump

The database structure is added automatically when running the server for the first time.
Just add the entities.

View dumps folder

 

Run server automated tests

All tests are inside __tests__ folder, ending with .test.ts

npm run test