Plataforma de gerenciamento de entregas

Sobre o projeto | Tecnologias | Guia de instalação e execução | Como contribuir | Licença

Layout

🚀 Sobre o projeto

Esta é uma plataforma para uma entregadora fictícia chamada Festfeet. A versão web é para os administradores onde eles podem gerenciar os destinários, entregas e problemas.

A versão mobile foi desenvolvida para os entregadores gerenciar suas entregas e informar problemas que podem ocorrer.

Este é o repositório da API do projeto.

• Para a versão web, clique aqui.
• Para a versão mobile, aqui.

💻 Tecnologias

Além das tecnologias abaixo, esta aplicação foi desenvolvida com as melhores práticas de desenvolvimento!

• Node.js
• Express
• ESLint-Airbnb, Prettier e EditorConfig
• Yup
• Multer
• Datefns
• Dotenv
• Bcrypt.js
• Jsonwebtoken
• Sequelize
• Handlebars
• Nodemailer
• Cors
• Sucrase
• Nodemon
• Bee Queue

📚 Guia de instalação e execução

Pré-requisitos

• Git
• Node.js >= v10.20
• Yarn
• Uma instância de PostgreSQL

** Ou Docker

Como executar

Antes de executar estes passos, você precisa ter uma instância dos bancos listados acima ou um Docker com as imagens e os databases e schemas criados.

• Clone o repositório git clone https://github.com/nathaliacristina20/fastfeet.git
• Vá até o diretório cd fastfeet
• Execute yarn para instalar as dependências
• Copie o arquivo .env.example executando cp .env.example .env para linux ou mac e copy .env.example .env para windows
• Abra o arquivo .env e preencha com suas variáveis de ambiente
• Execute yarn sequelize db:migrate para rodar as migrations
• Execute yarn dev para rodar o servidor
• Em outro terminal, execute yarn queue para rodar uma fila

Você pode realizar requisições REST através do Insomnia

📝 Como contribuir

Faça um fork deste repositório

# Clone o seu fork
$ git clone url-do-seu-fork && cd fastfeet

# Crie uma branch com sua feature ou correção de bugs
$ git checkout -b minha-branch

# Faça o commit das suas alterações
$ git commit -m 'feature/bugfix: minhas alterações'

# Faça o push para a sua branch
$ git push origin minha-branch

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

📃 Licença

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

---

by Nathalia Cristina 👋 Get in touch!