🐾 Projeto de Desenvolvimento Web 2020.3

Sobre   |    Apresentação   |    Utilização   |    Documentação da API   |    Detalhes do Front-end   |    Licença

🦉 Sobre

Em tempos que estamos todos em casa, isolados (ou pelo menos deveríamos), nunca se fez tão importante ter um amigo por perto, então por que não facilitar as pessoas a encontrarem novos amigos? 🙆🙆‍♂️

Estima-se que apenas no Brasil existe cerca de 30 milhões de animais abandonados, além dos animais apreendidos com pessoas que realizam maus-tratos e atividades ílicitas. E durante esse momento pandêmico diversas ONG's vem relatando o aumento de casos de abandono, como mostra essa reportagem da Folha de S. Paulo.

Logo, a ideia por trás desse projeto é unir ONG's que realizam a conexão entre pessoas e animais vítimas de maus-tratos, de abandono, ou de qualquer outras circunstâncias que os levaram a chegar nessas instituições, e pessoas interessadas em dar um novo lar para esses bichinhos. Portanto, a ONG realizará um cadastro sendo passado algumas informações importantes, e daí poderá postar fotos e informações dos animais.
Os usuários acessarão o site e poderão filtrar por espécie e localidade, além de verificar informações mais detalhadas sobre o próprio animal e a instituição, poderá realizar uma doação e entrar em contato com os responsáveis para tratar diretamente sobre a adoção, isso tudo sem necessidade de realização de cadastro.

⚠️ Se deseja conhecer todas as rotas disponíveis clique aqui
⚠️ Se deseja conhecer todas as telas construídas para este projeto clique aqui

🎬 Apresentação do Projeto

O backend e frontend foram implantados e estão disponíveis nas seguintes URLs:

• Backend: https://adoptemeapi.herokuapp.com/
• Frontend: https://adoptme-project.netlify.app/

🛠 Utilização

⚠️ já existem ONGs cadastradas:

Email	Senha	Estado
[email protected]	123456	Paraíba
[email protected]	123456	Sergipe
[email protected]	123456	São Paulo

• Pré-requisitos

  • É necessário possuir o Node.js instalado no computador
  • É necessário possuir o Git instalado e configurado no computador
  • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.

1. Faça um clone do repositório:

  $ git clone https://github.com/HigorSnt/adopt.me.git

2. Executando a Aplicação:

  # Inicialmente, é importante entrar na pasta gerada após o comando de clone
  $ cd adopt.me

  # Em seguida, é importante abrir a pasta da API
  $ cd server
  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  # Configurando o banco de dados e criando as tabelas.
  $ yarn knex:migrate # ou npx knex:migrate
  # Inicie a API
  $ yarn start # ou npm start

  # Aplicação web
  $ cd client
  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  # Inicie a aplicação web
  $ yarn start # ou npm start

🦊 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.