- Apresentação
- Motivações
- Transformar CÃOtagem
- Missao, valores e objetivo do projeto
- Escopo para aplicação mobile
- Tecnologias, dependências e bibliotecas
- Funcionalidades
- Instruções para instalação e contribuições no projeto
- Features e rotas
- Implementações futuras
- Referências
O "Achei um pet" tem como objetivo registrar animais que estão em situação de rua, reunindo as informações em uma comunidade de pessoas que desejam ajuda-los.
Muitas pessoas desconhecem todo trabalho feito anterior ao processo de adoção dos animais resgatados, muitas das vezes atribuíndo os cuidados anteriores somente a ONGs, porém há uma GRANDE comunidade de pessoas, em maioria mulheres, que muitas das vezes sem condições financeira e sem todos os recursos necessários se disponibilizam a ajudar a causa fazendo resgates, transportes, levando na assistência veterinária e dando lares temporários a esses animais em estado de rua.
Essa é uma API feita para o projeto final do {reprograma}, e tem como objetivo registrar casos de animais nas ruas e pessoas que desejam ajudar, fazendo as conexões principalmente através da aproximidade entre eles.
Há mais de 6 anos faço ações voluntárias na causa animal, com materias de divulgações de casos que precisam de ajuda e fazendo alguns resgates. Durante todo esse tempo as redes sociais eram os principais veiculos de divulgação, porém alguns problemas como perder informações ao meio de postagens de outros assuntos, problema com entrega desse tipo de postagens e falta de ferramentas especificas que ajudam no processo fazem com que nem sempre a rede de apoio atinja seu potêncial maximo e ajude todos ou a maioria dos animais que encontramos todos os dias nas ruas dos trajetos coditianos.
Juntamente com uma protetora, Viviane Arêdes, criamos o projeto Tranformar Cãotagem. Tinhamos o intuito de efetivamente fazer a diferença na quantidade de animais de rua na nossa cidade de Contagem, porém esbarramos na falta de informações sobre a quantidade de animais na nossa cidade.
Essas situações fizeram a ideia do Achei um pet surgir, e hoje com o conhecimento em API adquiridos no curso pude realizá-lo.
Essa API foi desenvolvida com intuito de ser uma ferramenta de auxilio a comunidade disponibilizada pelo projeto TransformarCãotagem. O projeto tem como objetivo ajudar nos resgates de Cadelas prenhas ou com ninhadas e filhotes das ruas da cidade de Contagem - MG. O projeto não tem investimento e é mantido com doaçẽs e rifas solidárias.
Pretendiamos fazer métricas de acompanhamento da população de animais de rua, porém faltam informações advindas da prefeitura e zoonose e de sensos sobre animais de rua. Acreditamos que linhando resgate de cadelas com ninhadas ou prenhas, castração e adoção responsável, e futuramente com sucesso de nossos esforços, a identificação e registro desses cães em uma base de dados, almejamos gradualmente frear e diminuir os casos de cachorro de rua. Lutamos também para que o poder público assuma sua responsabilidade a respeito da garantia do bem estar dos animais.
- Login
- Cadastro de usuário
- Cadastro animais em situação de rua
- Lista de todos animais cadastrados (Feed)
- Lista de todos animais filtrados aproximidade do usuário
- Dar Up(curtida) em uma postagem
- Visualização detalhada de um caso
- Atualização de cadastro de usuário
- Visualizar todas as postagens feitas pelo usuário
- Visualizar usuário
- Ter unformações para ajuda se os dados forem liberados pelo usuário
- Remoção postagem
-
Faça um
forkdo projeto através do link API Achei um pet. -
Copie o código do fork realizado e, no prompt de comando da sua máquina, realize o clone do projeto através do
git clone <link_do_fork_do_repositorio>; -
Crie uma branch para realizar suas contribuições
git checkout -b feature/<sua_branch>; -
Instale as dependências necessárias à execução da API através do comando
npm install; -
No raiz do projeto, renomeie
.env.examplepara.enve adicione os valores das variáveisPORT(porta sugerida8080),MONGODB_URL(string de conexão com o banco de dados) eSECRET(chave RSA). Elas são necessárias para a execução da API em sua máquina -
Para executar a API, utilize o comando
npm startno seu terminal; -
Após suas contribuições no projeto, realize o commit com o comando
git commit -m 'sua mensagem'; -
Para subir o projeto no seu GitHub, basta executar o comando
git push origin feature/<sua_branch>; -
E finalize criando um novo Pull Request com as contribuições para o projeto original.
Esta API está sendo escutada na porta 3000 e para que todas as rotas possam ser acessadas localmente é necessário usar http://localhost:3000/ ou https://achei-um-pet-service.herokuapp.com/ antes dos endpoints de requisição.
| Feature | Método | Rota |
|---|---|---|
| Login | POST | /login |
| Cadastro de usuario | POST | /users |
| Feed | PUT | /posts |
| Postagem detalhada | GET | /posts/:id |
| UP (Curtida) | GET | /posts/:id/up |
| Ajudar um caso | GET | /posts/:id/help |
| Cadastra animais de rua | POST | /posts/post |
| Visualizar postagens de um usuario | POST | /users/:id/posts |
| Buscar usuario | GET | /users/:id/user |
| Buscar proximo a localidade do usuário | GET | /posts?postalCodeFilter=5 |
| Atualizar cadastro | PATCH | /posts/:id/update |
| Apagar postagem feita | DELETE | /posts/user/:id/post/:id |
- Mapear os casos e mostra-los no mapa. Sendo possível fazer um levantamento dos casos nas regiões, podendo ter ações mais assertivas para conter os casos de animais em estado de rua.
-
Tirar fotos e posta-las direto de dispositivos moveis com acesso a internet.
-
Receber notificações de casos registrados próximos do usuario.
-
Registrar caso com endereço da sua localização atua.
{reprograma} - README ex-Aluna Pricilla Estevão
Criado com por Darielly Santos e o apoio das professoras, monitoras, orientação pedagógica, minhas amigasde turma que se apoiaram durante todo p processo e minha amiga e mentora Adila Fattobene que sempre esteve a disposição para me tirar duvidas. SEm elas esse trabalho não existiria. Obrigada !
