💡 Sobre

O Find a Friend é um app para encontrar o pet ideal para seu estilo de vida desenvolvido no módulo sobre API REST da formação de Node.js da Rocketseat.

📃 Pré-requisitos

1. Antes de começar, certifique-se de ter o Node.js instalado em sua máquina.

⚙️ Configuração

1. Clone o repositório para sua máquina local:

git clone https://github.com/carlos-hfc/find-a-friend

2. Acesse o diretório do projeto:

cd find-a-friend

3. Instale as dependências:

npm install

4. Crie um arquivo .env.local na raiz do projeto e adicione as seguinte chaves:

NODE_ENV=""
DATABASE_URL=""
JWT_SECRET=""

5. Rode a aplicação

npm run dev

🖱️ Features

Requisitos funcionais

• ☑️ Deve ser possível se cadastrar como uma ORG
• ☑️ Deve ser possível realizar login como uma ORG
• ☑️ 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

Regras de negócio

• ☑️ Uma ORG precisa ter um endereço e um número de WhatsApp
• ☑️ Para um ORG acessar a aplicação como admin, ela precisa estar logada
• ☑️ O usuário que quer adotar, entrará em contato com a ORG via WhatsApp
• ☑️ Um pet deve estar ligado a uma ORG
• ☑️ Para listar os pets, obrigatoriamente precisamos informar a cidade
• ☑️ Todos os filtros, além da cidade, são opcionais

💻 Tecnologias utilizadas

📄 Licença

Este projeto está licenciado sob a Licença MIT.