SACT Project

Web system for evaluating technical completion projects!
Explore the API Spec »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This project deals with a intern software solution for the Fundação Matias Machline, who intends to efficiently assist in the planning and organization of the evaluations of the course completion projects during the technical fair at the FMM.

The system should store information about the evaluators, also providing evaluation sheets for them based on their respective schedule, avoiding possible conflicts of visits and evaluations. The system must also be able to inform the projects that have been evaluated or not in real time.

Team

• Apolo Freitas (Front-end developer)
• Débora Colhyer (Designer)
• Euclides Lins (Back-end developer)
• Ian Marcony (Front-end developer)
• Leonardo Viana (Back-end developer)
• Lorenzo Windmoller Martins (Full-stack developer)

How to install?

1. To run the back-end, 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, Redis 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 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 front-end, follow these steps:

• Navigate to the frontend folder and install the dependencies:

// Navigate to the frontend folder
$ cd frontend

// Install application dependencies
$ yarn

• Create a file called .env based on .env.example and enter the API URL;
• Start the application using the command:

// Start the application
$ yarn start

Built With

• Front-end framework: React.js
• Back-end framework: Node.js
• Back-end data processing technology: TypeORM
• Database technology: MySQL and Redis
• Technology for testing implementation: Jest
• Environment creation tool: Docker
• API documentation tool: SwaggerHUB
• Prototyping tool: Figma

Contact

Apolo Freitas - LinkedIn - apolobrener11@gmail.com

Débora Colhyer - LinkedIn - dcolhyer@gmail.com

Euclides Lins - LinkedIn - euclidesvasconcelos01@gmail.com

Ian Marcony - LinkedIn - imarconyls@gmail.com

Leonardo Viana - LinkedIn - vianaleonardo.es@gmail.com

Lorenzo Windmoller Martins - LinkedIn - lorenzomart01@gmail.com

Acknowledgements

• README Template by othneildrew
• Img Shields