[EN-US]

What is Mayday?

Mayday is an MVP (Minimum Viable Product) made in React, Spring Boot, and persisted in PostgreSQL. It was coded for the Technical Residency in Information Systems subject by the informatics institute of the Federal University of Goiás and intends to solve processual problems of the Civil Defense of Goiás (DCGO) related to some inneficiencies in their contingency plan activation which was still made analogically.

Tech stack

ReactJS(UI): For the development of the Mayday user interface, we choose the facebook library ReactJS since it is, at the time of development of this project (Q4-2021 -> Q1-2022) a versatile, modern and performative library that brings practicality to the front-end development process.

Java Spring-Boot(Back-end): For the development of APIs and reverse-proxies of Mayday we chose the java language (Oracle Corporation) and the spring Spring-boot framework (Both by Rod Johnson et al) since they are technologies that are commonly used by the Civil Defense of the state of Goiás, have large communities behind them and bring ease and speed to the development of Java applications.

PostgreSQL(Databases and Persistence): For the storage and persistence of Mayday data, we selected postgresql because it is a robust, fast, open-source DBMS and, of course, easy to adopt by the civil defense;

Prototype

Mayday's prototype can be found on Figma: https://www.figma.com/file/6wR95ooBlrgXvQEg6dHQnW/DPE-GO-Mayday?node-id=0%3A144

How to run this project?

1. Open your favorite terminal (In our case we use Windows Terminal connected to an instance of WSL 2
2. Clone this repository git clone [email protected]:rique223/mvp-mayday.git
3. Acces the project's directory and execute the command yarn or npm install if you are using npm. P.S.: Yarn is faster ;)
4. Run the project with yarn start or npm run start

[PT-BR]

O que é o Mayday?

O Mayday é um MVP (Minimum Viable Product - Produto Viável Mínimo feito em React, Spring Boot e persistido no PostgreSQL. Ele foi codificado para a matéria de Residência Técnica em Sistemas de Informação pelo Instituto de Informática da Universidade Federal de Goiás e pretende sanar problemas processuais da Defesa Civil do estado de Goiás (DCGO). Dentre eles, a dificuldade de comunicação com os principais agentes da ativação de um plano de contingência e a digitalização do processo em si.

Tecnologias

ReactJS(UI): Para o desenvolvimento da interface de usuário do mayday foi escolhida a biblioteca do facebook ReactJS uma vez que é, na data de desenvolvimento desse projeto(Q4-2021 -> Q1-2022) uma biblioteca versátil, moderna e performática que traz grande praticidade para o processo de desenvolvimento front-end.

Java Spring-Boot(Back-end): Para o desenvolvimento das APIs e proxys-reversos do Mayday escolhemos a linguagem java (Oracle Corporation) e o framework spring Spring-boot (Ambos de Rod Johnson et al) uma vez que são tecnologias que são de uso costumeiro da Defesa civil do estado de Goiás, têm grandes comunidades por de trás e trazem facilidade e velocidade para o desenvolvimento de aplicações Java.

PostgreSQL(Banco de dados/Persistência): Para o armazenamento e persistência de dados do Mayday selecionamos o postgresql por ser um SGBD robusto, veloz, open-source e, claro, de fácil adoção pela defesa civil;

Protótipo

O protótipo do mayday encontra-se no figma: https://www.figma.com/file/6wR95ooBlrgXvQEg6dHQnW/DPE-GO-Mayday?node-id=0%3A1

Como Rodar esse projeto?

1. Abra seu terminal favorito(No nosso caso usamos o Windows Terminal conectado a uma instância do WSL 2
2. Clone esse repositório git clone [email protected]:rique223/mvp-mayday.git
3. Acesse o diretório do projeto e execute o comando yarn ou npm install caso use o npm. P.S.: O yarn é mais rápido ;)
4. Execute o projeto com yarn start ou npm run start