RaDop App Server

O RAS (RaDop App Server) é o serviço responsável pelo back-end do aplicativo RaDop. Neste projeto está contemplado os CRUDs (Create, Read, Update e Delete) necessário para o funcionamento do app, assim como as funções de autenticação de usuário.

Parâmetro

O RAS roda no formato de uma API Rest, portanto não há um formato padrão para o parâmetro de funcionamento. Abaixo estará explicito para cada rota como se usa as funções do RAS.

Tecnologia Utilizada

• Node JS (versão 11.15)
• AdonisJS (versão 4.1)
• PostgreSQL
• JWT

Ambiente de Desenvolvimento

Para evoluções e desenvolvimento basta ter instalado em sua máquina o Node JS, versão 10 ou superior, a instalação do Node JS pode ser vista aqui (caso queira pode instalar o gerenciador de pacotes Node yarn). As demais dependências do projeto são listados no package.json e a instalação de um editor de texto da sua preferência.

Deploy Local para Desenvolvimento

Para testar localmente rode o comando:

adonis serve --dev

Com isso todas as rotas do RAS estarão disponíveis na URL: http://localhost:3333

Caso queira testar via docker compose basta rodar o comando:

docker-compose -f docker-compose.yml up --build

Fazer as Migrações das Tabelas

Assim que seu ambiente local esteja rodando execute o comando:

adonis migration:run

Caso o seu ambiente esteja rodando com o docker compose basta rodar:

docker-compose run --rm server adonis migration:run

Com isso todas as migrações do banco vão ser registradas no seu banco local.

Populando o Banco de Dados

Agora para inserir alguns objetos no banco de dados rode o seguinte comando:

adonis seed --files UserSeeder.js
adonis seed --files RadarSeeder.js
adonis seed --files MaintanenceSeeder.js
adonis seed --files StatusSeeder.js

Ou caso o seu ambiente esteja rodando com o docker compose basta rodar:

docker-compose run --rm server adonis seed --files UserSeeder.js
docker-compose run --rm server adonis seed --files RadarSeeder.js
docker-compose run --rm server adonis seed --files MaintanenceSeeder.js
docker-compose run --rm server adonis seed --files StatusSeeder.js

Agora o seu banco está populado e pronto para testes.

OBS: Comando em uma linha só pode ser:

docker-compose run --rm server adonis migration:run && docker-compose run --rm server adonis seed --files UserSeeder.js && docker-compose run --rm server adonis seed --files RadarSeeder.js && docker-compose run --rm server adonis seed --files MaintanenceSeeder.js && docker-compose run --rm server adonis seed --files StatusSeeder.js

Execução do Ambiente de Testes

Testes

O ambiente de testes ainda está em fase de configuração, assim que finalizado nessa seção terá os comandos e exemplos de como executar este processo.

Linter

eslint .

Build

Para construir a imagem do RAS basta rodar os seguintes comandos:

docker build -t radop-app-server:latest .

Para rodar a imagem construída do RAS utilize do Docker Compose presente no projeto, com isto o serviço irá subir já com o container do banco de dados (PostgreSQL). O comando para rodar os serviços é:

docker-compose -f docker-compose.yml up --build

OBS: Caso não tenha construído a imagem antes basta adicionar a flag --build ao final do comando do Docker Compose. Caso queira que os serviços rodem no background bata adicionar a flag -d ao final do comando do Docker Compose.