🚀 Found Lost Pet

Backend da aplicação Found Lost Pet

Features   |    Pré-Requisitos   |    Backend   |    Bibliotecas   |    Lincença

🚧 Finalizado 🚧

📖 Documentação

📎 Features

Desaparecimentos

• Criação de um desaparecimento
• Deleção de um desaparecimento
• Atualização de um desaparecimento
• Listagem de desaparecimento com filtros

Comentários

• Criação de um comentário
• Deleção de um comentário
• Atualização de um comentário
• Listagem dos comentário por registro de desaparecimento

Usuários

• Autenticação
• Criação de Perfil
• Atualização de Perfil

⚙ Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e/ou Yarn Também, será necessário ter o Docker instalado e configurado em sua máquina. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Back End (servidor)

# Clone o repositório
$ git clone https://github.com/gabriel-nt/gtn-book

# Instale as dependências
$ npm install ou yarn

# Rode as migrations
$ yarn typeorm migration:run

# Execute a aplicação em modo de desenvolvimento
$ yarn start:dev ou npm run start:dev

# Execute a aplicação em modo de produção
$ yarn start:prod ou npm run start:prod

# O servidor inciará na porta:3000 - acesse <http://localhost:300>

• Obs: Para executar os backend, crie um banco de dados.

🧾 Insomnia

Para ter um exemplo das rotas para a nossa API, basta clicar no link abaixo:

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• NestJs
• TypeScript
• Postgres

📕 Bibliotecas

Esse projeto foi desenvolvido com o auxílio das seguintes libs:

• Express
• TypeORM
• jwt
• dayjs
• swagger

📙 Arquitetura do Projeto

Para uma melhorar estrutura de projetos utilizamos das seguintes fundamentos:

• DDD
• Solid
• Clean Arch

📘 Padrão de Código

Para padronizar a escrita do código, utilizamos as seguinte ferramentas:

• Eslint
• Prettier
• EditorConfig

📝 Licença

Esse projeto está sob a licença MIT.

---

Feito por Gabriel Teixeira