Sistema feito para funcionários && empresas. Este irá facilitar a adesão do colaborador ao transporte fretado de sua empresa, com a vantagem de ser prático e favorecer a autonomia de todos os envolvidos.
| Ferramenta | Descrição |
|---|---|
javascript |
Linguagem de programação |
nodejs |
Ambiente de execução do javascript |
express |
Framework NodeJS |
dotenv |
Dependência para proteger dados sensíveis do projeto |
mongoose |
Dependência que interage com o MongoDB para a conexão da database, criação do model e das collections |
nodemon |
Dependência que observa as atualizações realizadas nos documentos para rodar o servidor automaticamente |
npm |
Gerenciador de pacotes |
MongoDB |
Banco de dado não relacional orientado a documentos |
Mongo Compass/Mongo Atlas |
Interface gráfica para verificar se os dados foram persistidos |
Insomnia ou Postman |
Interface gráfica para realizar os testes |
Requisições para a API devem seguir os padrões:
| Método | Descrição |
|---|---|
GET |
Retorna informações de um ou mais registros. |
POST |
Utilizado para criar um novo registro. |
PUT |
Atualiza dados de um registro. |
DELETE |
Remove um registro do sistema. |
- Clone o repositório
- Instale as dependências com
npm install - Crie um arquivo
.env(para conexão do banco de dados). - Copie o conteúdo de
.env.examplepara o arquivo.env(aqui ficarão as credenciais de seu database). - Inicie o servidor com
npm start
Método GET
- "/buses/list" Deverá retornar todas as linhas de ônibus cadastradas no banco de dados.
- "/neighborhoods/list" Deverá retornar todos os bairros cadastrados.
- "/neighborhoods/neighborhood" Deverá retornar a linha de ônibus que cobre o bairro requisitado pelo usuário.
Método POST
- "/buses/create" Deverá adicionar um novo transporte à rota.
- "/neighborhoods/create" Deverá cadastrar um novo bairro no banco de dados.
Método DELETE
- "/buses/:id" Deverá deletar um transporte por id específico e retornar mensagem de sucesso na execução.
- "/neighborhoods/:id" Deverá deletar um bairro por id específico e retornar mensagem de sucesso na execução.
Método PUT
- "/buses/:id" Deverá alterar informação de um transporte por id específico e retornar a alteração.
- "/neighborhoods/:id" Deverá alterar informação de um bairro por id específico e retornar a alteração.