SecexLog Project

Web software for planning the performance of audits in the state of Amazonas!
Explore the API Spec »

Report Bug · Request Feature

Table of Contents

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

About The Project

This project is about a software solution for the Tribunal de Contas do Estado do Amazonas in partnership of Fundação Matias Machline that intends to improve the efficiency of the planning the performance of Audits in the interior of the State of Amazonas with logistical information such as Dates, Travel Time and Possible Travel Modes.

The System aims to inform TCE officials responsible for planning the audits a complete logistical view since your departure until your return, also informing you of possible holidays in the desired period, or occurrence of public calamities, such as floods, and being possible to be updated with recent information on the use of logistics (eg New Modals, new service providers, new routes, etc).

This system must be able to perform the logistical functions from Manaus to one, two or even 3 audited cities, eventually passing through a base city, and the return to Manaus.

Team

• Débora Colhyer (Designer)
• Euclides Lins (Back-end developer)
• Gustavo Fadel (Front-end developer)
• Leonardo Viana (Back-end developer)
• Lorenzo Windmoller Martins (Full-stack developer)
• Pedro Henrique Martins (Back-end developer)
• Pedro Henrique Souza (Front-end 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

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

Contact

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

Gustavo Fadel - LinkedIn - ghffadel@gmail.com

Euclides Lins - LinkedIn - euclidesvasconcelos01@gmail.com

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

Lorenzo Windmoller Martins - LinkedIn - lorenzomart01@gmail.com

Pedro Henrique Martins - LinkedIn - pedroh93601@gmail.com

Pedro Henrique Souza - LinkedIn - pedroaraujo1952@hotmail.com

Acknowledgements

• README Template by othneildrew
• Img Shields