ReservaLab Project

Web system to facilitate the teachers' work!
Explore the API Spec »

Report Bug · Request Feature

Table of Contents

• About the Project
• How to install?
• Built With
• Contact
• Acknowledgements

About The Project

The ReservaLab project deals with an internal software solution from the Fundação Matias Machline, which aims to automate the process of allocating laboratories, in addition to allowing teachers, monitors and advisors to efficiently control the frequency management and programs installed on computers.

How to install?

1. To run the backend, follow these steps:

• Navigate to the backend folder and install the dependencies:

// Navigate to the backend folder
$ cd backend

// Install application dependencies
$ yarn

• Install MySQL, MongoDB, and Adminer Docker images using docker-compose:

// Run the Docker images
$ docker-compose up -d

• Create a file called .env based on .env.example and enter your AWS credentials;
• Create a file called .ormconfig.json based on .ormconfig.example.json and insert the MySQL and MongoDB host and port according to the previously installed Docker images, in addition to exchanging the src recipient for dist and .ts for .js;
• Configure the credentials of the MySQL Docker image using the following commands:

// Enter the MySQL image bash
$ docker exec -it IMAGE_NAME bash
// Enter the MySQL image root
$ mysql -u root -p
// Change the password
$ ALTER USER root IDENTIFIED WITH mysql_native_password BY ‘ROOT_USER_PASSWORD’;

• Run the database migrations using the command:

// Run the migrations
$ node_modules/.bin/typeorm migration:run

• Add a no-restart configuration for each Docker image using the command:

// Change the configuration of the Docker images
$ docker update --restart=unless-stopped ID_DA_IMAGEM

• Start the server using the command:

// Start the server
$ yarn dev:server

2. To run the frontend, follow these steps:

• Navigate to the frontend folder and install the dependencies:

// Navigate to the frontend folder
$ cd frontend

// Install application dependencies
$ yarn

• Start the application using the command:

// Start the application
$ yarn start

Built With

• Framework for platform frontend: React.js
• Backend Framework: Node.js
• Database technology: MySQL and MongoDB
• Backend data processing technology: TypeORM
• Technology for testing implementation: Jest
• API documentation tool: SwaggerHUB
• Prototyping tool: Adobe XD

Contact

Lorenzo Windmoller Martins - LinkedIn - lorenzomart01@gmail.com

Acknowledgements

• README Template by othneildrew
• Img Shields