Projeto Final {Reprograma} - Lanac (Lar Nazareno da Criança)

Introdução

Esse projeto foi desenvolvido como etapa de conclusão do curso Backend da {Reprograma}. É inspirado no Lar Nazareno da criança (Lanac), uma ONG que atende crianças de forma gratuita, com aula de reforço e creche em tempo integral. Localizada na cidade de Paulista- Pernambuco, na qual sou voluntária. Todos os anos, no mês de dezembro, a Lanac faz um projeto de apadrinhamento para doações de roupas e brinquedos.

Objetivo

O Objetivo deste projeto é cadastrar pessoas que tenham o desejo de apadrinhar as crianças da comunidade,que vivem em situação de vunerabilidade.

Apresentação

Apresentação aqui

Documentação

Acesse a aplicação aqui |

Acesse a documentação aqui

Arquitetura do Projeto

 📁PROJETO FINAL
   |
   |--📁Lanac
   |
   |--📁node_modules
   |
   |--📁 src
   |  ||
   |  ||
   |  ||--📁 controllers
   |  |    |- 📄 criancasController.js
   |  |    |- 📄 padrinhosController.js
   |  |
   |  ||--📁 database
   |  |    |- 📄 dbConnect.js
   |  |
   |  ||--📁 models
   |  |    |- 📄 criancasModel.js
   |  |    |- 📄 padrinhosModel.js
   |  |
   |  ||--📁 routes
   |  |    |- 📄 criancasRoutes.js
   |  |    |- 📄 padrinhosRoutes.js
   |  ||-📄 app.js
   |  |
   |  |--📁 swagger
   |  |   |- 📄 swagger_output.json
   |  |
   |- 📄 .env
   |- 📄 .env.example
   |- 📄 .gitignore
   |- 📄 package-lock.json
   |- 📄 package.json
   |- 📄 README.md
   |- 📄 server.js
   |- 📄 swagger.js

Tecnologias e Dependências Utilizadas

Ferramenta	Descrição
`javascript`	Linguagem de programação.
`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.
`bcrypt`	Bcryptjs é uma biblioteca para encriptação de dados. Neste caso, o dado a ser criptografado é o password.
`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.
`swagger`	Gera a documentação.
`heroku`	hospeda a documentação.

Funcionalidades

O schema de crianças na API deve conter name, age, clothesSize, shoe e gender;
O schema de padrinhos na API deve conter name, cpf, telephoneOrWhatsapp, adress, email e gender;
A API deve permitir o cadastro de crianças ;
A API deve permitir o cadastro de padrinhos;
A API deve listar crianças cadastradas;
A API deve listar padrinhos cadastros;
A API deve retornar criança por id;
A API deve retornar padrinho por id;
A API deve permitir modificação em criança;
A API deve permitir modificação em padrinho;
A API deve permitir deletar cadastro de criança;
A API deve permitir deletar cadastro de padrinho;

Exemplo de estrutura de cadastro de criança :

{
  "name": "Matheus Henrique", 
  "age": 8,
  "clothesSize": "Blusa tamanho Pgit , short 32",
  "shoe": "32",
  "gender": "masculino"
}

Exemplo de estrutura de cadastro de padrinho :

{
    "name": " Natalia Cardoso",
    "telephoneOrWhatsapp": 8198736900,
    "adress": "Av. Marlon Barros, 125",
    "email": "cardoso@gmail.com",
    "gender": "feminino"
}

Contribua com esse projeto

Faça o fork do projeto;

Crie uma branch para realizar suas alterações: git checkout -b feature/nome-da-nova-branch

Instale as dependências:

$ npm install

$ npm install dotenv --save

Commit as alterações feitas e abra um pull request

Agradecimentos

Gratidão a todos que fazem a {reprograma} acontecer, vocês passaram pela minha vida e me transformaram. A todas as mulheres incríveis da on19 que eu tive a SORTE de conhecer, vocês foram fundamentais nessa caminhada. Grata a todas as professoras por tanto empenho e paciência, vocês são incríveis. Em especial a minha amiga Shirlene por todo apoio durante todo o curso, sem você eu não conseguiria. A minha família, amigos e todos que fizeram parte da construção desse sonho. 💜🦋

🌻 Desenvolvedora

Desenvolvido por

MariaThays/Lanac