Turma On19 backend da {Reprograma}!
🐾🐾🐾🐾Sobre o Projeto🐾🐾🐾🐾
O projeto carneira foi inspirado em uma gatinha deficiente que eu tive, que infelizmente faleceu no dia 12/07/2022, por conta de uma cistite, e de uma constipação intestinal. Ela me motivou muito, pois mesmo com as suas dificuldades de locomoção, e outros problemas acarretados pela sua deficiência, isso nunca foi um empecilho para que ela vivesse plenamente, e sempre feliz, mas também sempre pensando nos seus amiguinhos, e com seu espírito de mãe, acolhendo a todos que precisavam dela. O projeto foi inspirado nela devido aos medicamentos e a alimentação especial que ela necessitada para sobreviver.
🔗 Apresentação do Projeto🐾
O proposito desse projeto, é fazer parceria com o hospital veterinário da cidade do Recife, e ter uma Farmácia do SUS, para receber doações de medicamentos mesmo usados dentro do prazo de validade; rações especiais e o que for necessário para ajudar no tratamento dos animais que precisam de medicamentos e um tratamento diferenciado, podendo também contribuir em dinheiro sendo depositado na conta de um administrador, que passará todo o relatório do dinheiro que entrar. Esse projeto é sem fins lucrativos, e em prol da causa animal, buscando parceria e mantenedores para atender os animais que possuem maiores necessidades
🔗 Aplicação disponível🐾
Rotas🐾
•📁 Arquitetura MVC🐾
•📁 Projeto Carneira •|
•|--||---📁node_modules
•|
•|--||---📁 src
•| ||
•| ||
•| ||---📁 controllers
•| | |- 📄 doacaoController.js
•| ||---📁 database
•| || |- 📄 dbconectConnect.j
•| ||---📁 models
•| || |- 📄 pessoa.js
•| ||---📁 routes
•| || |- 📄 index.js
•| ||---📁 swagger
•| | •|- |-📄 package.json
•|- |-📄 README.md
•|- |-📄 server.js
•|- |-📄 swagger.js
💻 Instalação🐾
$git clone + link do repositóriol
npm init -y
npm install
npm install express
npm install nodemon
npm install mongoose
npm i --save-dev dotenv
npm i express cors
npm install --save dotenv-safe
npm i swagger-autogen swagger-ui-express
💾 Tecnologias e Dependências Utilizadas🐾
•Ferramenta /|Descrição🐾
•javascript /|Linguagem de programação utilizada nesse projeto.🐾
•node.js /|Ambiente de execução do javascript.🐾
•express /|Framework NodeJS.
•mongoose /|Dependência que interage com o MongoDB para a conexão da database, criação do model e das •collections.🐾
•nodemon /|Dependência que observa as atualizações realizadas nos documentos para rodar o servidor automaticamente.🐾
•npm /|Gerenciador de pacotes.🐾
•MongoDb /|Banco de dados não relacional orietado a documentos.🐾
•Mongo Atlas /|Interface gráfica para verificar se os dados foram persistidos.🐾
•Postman /| Interface gráfica para realizar os testes.🐾
•jsonwebtoken /|Dependência que implementa o protocolo JSON Web Token para segurança de dados.🐾
•bcrypt /|Biblioteca para encriptação de dados.🐾
•dotenv /| Dependência para gerenciar facilmente variáveis de ambiente, não é obrigatório para JWT, mas uma boa prática para configurações em geral.🐾
•jest /| Jest é uma estrutura de teste JavaScript.🐾
•swagger /|Gera a documentação do projeto.🐾
•Render /|Utilizado para realizar o deploy da aplicação e hospedar documentação.🐾
⚙️ Funcionalidades/Objetivos🐾
🔃 Retorna a documentação no swagger🐾 Swagger -
🔃 Retorna teste com apresentação🐾
🔃 Manipulação das Rotas de post (criar) doacao 🐾
🔃 Manipulação das Rotas para put (atualizar) id 🐾
🔃 Manipulação das Rotas para delete(deletar)
✅ Schema Doacao🐾
API deve retornar seguinte JSON:🐾
✅ Schemapessoa🐾
✅ API deve retornar seguinte JSON:🐾 name
🔃 [ POST ] : Login para geração de Token🐾 id
🔃 name 🐾
🔃 medicamento
🚧 Implementações futuras (Em andamento)🐾 Futuramente esse projeto , será em parceria com o Hospital Veterinário do Recife.
🛠️ Contribua para o nosso projeto!🐾 https://www.instagram.com/amordepatinhas2/
lá você tera maiores informações..
👨💻Autora🐾