This is the back-end of the Chronos Web App.
It's a REST API built with NodeJS + Express + MariaDB that receives data related to the departments, courses, subjects, and classes of the University of Brasília and record / provide to logged-in users all this data through a REST API.
This project is part of our studies about Software Requirements, then we'll be happy if you could provide us any feedback about the project, requirements, code, structure, or anything that you can report that could make us a better developer!
Email us at [email protected]
Connect with us at LinkedIn:
- Bruno Carmo
- Douglas Castro
- Guilherme Peixoto
- Guilherme Silva
To run this project in the development mode, you'll need to have a basic environment with NodeJS 14+ installed. To use the database, you'll need to have MariaDB installed and running on your machine.
Cloning the Repository
$ git clone https://github.com/ProExpertREQ/chronos-server.git
$ cd chronos-server
Installing dependencies
$ yarn
or
$ npm install
With all dependencies installed, .env variables set, the Database running, and the environment properly configured, you can now run the server:
$ yarn dev
or
$ npm run dev
The base URL is: http://localhost:3080/
- NodeJS - Build the server
- express - Router of the Application
- MariaDB - Database
- Sequelize - Object Modeling + DB Connector
- nodemon - Process Manager used in the development
- Google Cloud Platform - Compute Engine used in the production
- dotenv - Environment loader
- eslint - JS Linter and code style
This project is licensed under the MIT License - see the LICENSE.md file for details.