API-FindAFriend

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. Para garantir a qualidade foi configurado o ambiente CI com github actions.

#fastify#nodejs#postgresql#prisma#typescript#vitest

View Repository on GitHub ↗

REPOSITORY OVERVIEW

Live repository statistics

★ 5Stars

⑂ 0Forks

◯ 0Open issues

◉ 5Watchers

README preview

🚀 Tecnologias

Esse projeto está utilizando as seguintes tecnologias:

📜 Descrição

⚙️ Como funciona?

RFs (Requisitos funcionais)

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

Rotas da aplicação

A seguir estão as principais rotas da aplicação:

Usuários

POST /users: Cria um novo usuário.
POST /users/sessions: Autentica um usuário.

Organizações

POST /organizations: Cria uma nova organização.
POST /organizations/sessions: Autentica uma organização.

Pets

POST /pets/:organizationId: Cria um novo pet para uma organização específica.
DELETE /pets/:id: Deleta um pet.
GET /pets/city/:city: Lista todos os pets em uma determinada cidade.
GET /pets/filter: Filtra pets com base em critérios específicos.
GET /pets/details/:id: Obtém detalhes de um pet específico.

🎲 Quer customizar o projeto?

Clone esse repositório

git clone https://github.com/Savio-Anjos/API-FindAFriend.git

Navegue até o diretório do projeto

cd FindAFriend

Instale as dependências

npm i

yarn

Execute o docker compose

docker compose up

Execute o docker

docker start

Rode as migrations

npx prisma migrate dev

Inicie a aplicação

npm run start:dev