API desenvolvida para a adoção de animais, a FindAFriend API, utilizando SOLID e testes.
- Deve ser possível cadastrar um pet
- Deve ser possível listar todos os pets disponíveis para adoção em uma cidade
- Deve ser possível filtrar pets por suas características
- Deve ser possível visualizar detalhes de um pet para adoção
- Deve ser possível se cadastrar como uma ORG
- Deve ser possível realizar login como uma ORG
- Para listar os pets, obrigatoriamente precisamos informar a cidade
- Uma ORG precisa ter um endereço e um número de WhatsApp
- Um pet deve estar ligado a uma ORG
- O usuário que quer adotar, entrará em contato com a ORG via WhatsApp
- Todos os filtros, além da cidade, são opcionais
# Faça o clone do repotório
git clone git@github.com:RenanFachin/RS_IGNITE_find-a-friend-api.git
# Instalar as dependências do projeto
npm install
# Rodar as migrations do projeto para criar o banco de dados
npx prisma migrate dev
# Executando o projeto no ambiente de desenvolvimento
npm run dev
# Subindo o banco de dados com docker
docker compose up -d
- Criar nova organização
POST /register
- Login na aplicação
POST /session
- Cadastrar um pet
POST /register/pet
- Buscar por um pet
GET /pet/:id
- Listar todos os pets de uma cidade específica
GET /searchByCity/:city
- Filtrar pet por característica e cidade
GET /search/:city
# Rodando testes unitários
npm run test
# Vendo o coverage de testes
npm run test:coverage
# Rodando testes unitários
npm run test:e2e