Projeto Adote Fácil

Introdução

O "Adote Fácil" é um sistema voltado para facilitar a adoção de animais. A API provê serviços para gerenciamento de usuários, autenticação, cadastro de animais e gerenciamento de chats entre os usuários. O backend é construído com Node.js e Express, utilizando middlewares para autenticação e tratamento de upload de imagens. O frontend é desenvolvido com Next.js e React, proporcionando uma interface dinâmica e responsiva.

Tecnologias

• Node.js
• Express
• Multer (upload de arquivos)
• Axios (requisições HTTP no frontend)
• JWT (validação de tokens)
• Zod (validação dos dados no frontend)
• React (Next.js no frontend)
• Prisma (ORM no backend)
• PostgreSQL (banco de dados)

Documentação de rotas da API

Rotas de Usuários

• POST /users Cria um novo usuário. Exemplo de uso: Envio de dados com nome, email e senha para cadastro.

• PATCH /users Atualiza informações do usuário autenticado. Exemplo de uso: Atualização de dados do perfil.

Rotas de Autenticação

• POST /login Autentica um usuário utilizando email e senha. Retorna um token JWT e os dados do usuário em caso de sucesso.

Rotas de Chats

• POST /users/chats/messages Envia uma nova mensagem em um chat. Exemplo de uso: Permite que o usuário envie uma mensagem para um chat existente.

• POST /users/chats Cria um novo chat entre usuários. Exemplo de uso: Inicia uma conversa entre dois ou mais usuários.

• GET /users/chats Lista todos os chats do usuário autenticado.

• GET /users/chats/:chatId Recupera os detalhes de um chat específico pelo seu ID.

Rotas de Animais

• POST /animals Cria um novo anúncio de animal para adoção. Exemplo de uso: Envio de dados do animal e imagens (até 5 arquivos) utilizando o multer.

• PATCH /animals/:id Atualiza o status de um animal. Exemplo de uso: Permite alterar informações como disponibilidade para adoção.

• GET /animals/available Lista os animais disponíveis para adoção. Exemplo de uso: Permite filtragem por gênero, tipo e nome.

• GET /animals/user Recupera os animais associados ao usuário autenticado.

Tutorial de implantação

Certifique-se de ter o Docker e o Docker Compose instalados na sua máquina. Antes de iniciar o sistema, crie os arquivos .env nos diretórios /backend e /frontend baseando-se nos respectivos arquivos .env.example de cada um destes dois diretórios. Perceba que o conteúdo deles é diferente um do outro.

O arquivo .env.example do backend já contém as variáveis usadas pelo Docker Compose para criar os containers do banco e do backend com os valores corretos, então basta replicá-los. Caso queira, é possível alterá-las também.

As portas de execução do backend e frontend estão hardcoded no arquivo docker-compose.yml. O backend executa na porta 8080 e o frontend na porta 3000. É possível alterar estes valores, só tomando cuidado para refletir as alterações nas variáveis de ambiente das APIs.

Para subir os containers, entre na pasta /backend e execute o comando:

docker compose up

Em seguida, basta acessar a url http://localhost:3000 para ter acesso à plataforma (caso tenha trocado a porta de execução do frontend, altere o 3000 para a porta no qual o frontend está executando).