FastFeet

Esse projeto foi desenvolvido como uma solução ao desafio 2 e 3 da fase 02 do Bootcamp GoStack

📝 Índice

• Sobre
• Primeiros passos
• Rotas
• Feito com
• Licença

🧐 Sobre

App para uma transportadora fictícia, o FastFeet.

🏁 Primeiros passos

Estas instruçōes te darão uma cópia funcional do projeto na sua máquina local para desenvolvimento e testes.

Pré-requisitos

Instalar as dependências

yarn install

Instalação

Configurar a conexão com o banco de dados em src/config/database.js

module.exports = {
  dialect: 'postgres', // veja https://sequelize.org/v5/manual/dialects.html para mais informações sobre dialects
  host: 'localhost',
  port: 5433,
  username: 'postgres',
  password: 'postgres',
  database: 'fastfeet',
  define: {
    timestamps: true,
    underscored: true,
    underscoredAll: true
  }
};

Rodando a aplicação:

yarn dev

🚚 Rotas

MÉTODO	ROTA	BODY	FUNÇÃO
POST	/sessions	JSON	Cria um token JWT
GET	/deliverymen/:id	-	Mostra informações de um entregador
PUT	/deliverymen/:id	JSON	Atualiza informações de um entregador
DELETE	/deliverymen/:id	-	Deleta um entregador
GET	/deliverymen/:id/deliveries	-	Mostra as deliveries disponíveis para um entregador
GET	/deliverymen	-	Mostra informações de todos entregadores
POST	/deliverymen	JSON	Cadastra um entregador
GET	/recipients/:id	-	Mostra informações de um destinatário
PUT	/recipients/:id	JSON	Atualiza informações de um destinatário
DELETE	/recipients/:id	-	Deleta um destinatário
GET	/recipients	-	Mostra informações de todos destinatários
POST	/recipients	JSON	Cadastra um destinatário
GET	/deliveries/:id	-	Mostra informações de uma entrega
PUT	/deliveries/:id	JSON	Atualiza informações de uma entrega
DELETE	/deliveries/:id	-	Delete uma entrega
GET	/deliveries	-	Mostra informações de todas entregas
POST	/deliveries	JSON	Cadastra uma entrega
PUT	/deliveries/start-delivery/:id	JSON	Faz a retirada de uma entrega
PUT	/deliveries/finish-delivery/:id	JSON	Finaliza uma entrega
GET	/problems/:id	-	Mostra informações de um problema da entrega
PUT	/problems/:id	JSON	Atualiza informações de um problema da entrega
DELETE	/problems/:id	-	Deleta um problema de uma entrega
GET	/problems/	-	Mostra todas os problemas de uma entrega
POST	/problems/	JSON	Cadastra um problema na entrega
POST	/problems/:id/cancel-delivery	-	Cancela uma entrega
POST	/files	MULTI-PART	Faz upload de um arquivo

⛏️ Feito com

• PostgresSQL - Database
• Redis - Database
• Sequelize - ORM
• Express - Server Framework
• NodeJS - Server Environment
• JsonWebToken - Handling JWT auth
• Nodemailer - Email sending
• Bee-queue - Job queue
• Multer - Handling multipart/form-data

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.