tilo1306/FindAFriend-API

🚀 Tecnologias

Esse projeto está utilizando as seguintes tecnologias:

• Node
• Fastify
• Swagger
• Vitest
• Docker
• Prisma

📜 Descrição

Esse projeto consiste em uma API para uma aplicação de adoção de animais, nele foi utilizado padrões de arquitetura de software e foram desenvolvidos testes unitários e E2E.

⚙️ Como funciona?

RFs (Requisitos funcionais)

• É possível cadastrar um pet
• É possível listar todos os pets disponíveis para adoção em uma cidade
• É possível filtrar pets por suas características
• É possível visualizar detalhes de um pet para adoção
• É possível deletar um pet
• É possível se cadastrar
• É possível realizar login
• É possível realizar login com github
• É possível se cadastrar como uma ORG
• É possível realizar login como uma ORG

RNs (Regras de negócio)

• 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
• Todos os filtros, além da cidade, são opcionais

🎲 Como usar o projeto?

Clone esse repositório

git clone https://github.com/tilo1306/FindAFriend-API.git

Navegue até o diretório do projeto

cd FindAFriend-API

Execute atravez do docker

docker compose up -d

Acessar ao swagger

http://localhost:3333/docs/static/index.html