Skip to content

NadyLuna/Reprograma-BackEnd-ProjetoFinal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Intro

Emissão de Carteira de Estudante Universitária de forma prática e confiável.

🚧 Carteira de Estudante Fácil 🚀 Em construção... 🚧


Brief Overvienw

A ideia é dimirir as dificuldades para emissão de carteira de estudante para universitários, sem a necessidade de emissão de declarações e evitar declarações não aceitas, inclusive. Sobretudo, dirimir as fraudes na emissão de carteira de estudante.

A Faculdade se encarregará de enviar os seu dados e dos seus alunos e enviará para o estudante os dados de acesso a app, onde o mesmo terá que mudar a senha no seu primeiro acesso. Em seguida poderá verificar se está matriculado no período letivo e solicitar a carteira de estudante.

🏁 Features

  • Cadastro de faculdade/alunos

    • Cadastrar Faculdades e respectivos alunos através de IdFaculdade e e-mail e senha para alunos.
  • Atualizar dados Faculdade/alunos

    • Atualizar dados de Faculdade e alunos através de IdFaculdade e CPF aluno.
  • Deletar dados Faculdade/alunose

    • Deletar Faculdade e alunos através de IdFaculdade e CPF aluno.
  • Check

    • Checar se o aluno está matriculado e apto a solicitar carteira de estudante.

Back-end requirements

Rotas Descrição
GET/alunos Listar todos os alunos
GET/faculdade listar todas as faculdades
GET/alunos/cpf localizar aluno específico
GET/faculdades/idFaculdade localizar Faculdade específica
GET/faculdades/alunos/matriculados localizar alunos matriculados
GET/faculdades/alunos/pending localizar alunos Não matriculados
POST/faculdades/alunos Cadastrar nova Faculdade e alunos
POST/alunos Cadastrar novo aluno
PUT/faculdades/idFaculdade Alterar dados da Faculdade
PUT/alunos/cpf Alterar dados do aluno
PATCH/alunos/senha/cpf Alterar senha do aluno
DELETE/alunos/cpf Excluir aluno
DELETE/faculdades/idFaculdade Excluir faculdade

Install instructions

Getting Started

- Clone & Install Dependencies

1 - Git clone https://github.com/NadyLuna/Reprograma-BackEnd-ProjetoFinal.git
2- Instalar dependências NPM packages with npm install
2.1- Dependencies used

3- Execute npm start

4 - Verificar o arquivo .env.example quais as variáveis de ambiente necessárias;

* .env.example (Variáveis de ambiente necessárias)

MONGODB_URL=string_de_conexao_banco_de_dados
SECRET=chave_secreta
PORT=porta
  • Conectar ao MongoAtlas; Para criar ou utilizar um Cluster e inserir a String de Conexão no app.js. a URL do MONGO_URL fica "guardada" no .envconforme demonstrado no .env.example.
* String de conexão com Mongo Atlas
   
mongoose.connect(`${process.env.MONGODB_URL}`, {
    useNewUrlParser: true,      
    useUnifiedTopology: true
    });

- Deploy

Heroku

Acesse

- Language, Software and Database

JavaScript Nodejs MongoDB

- Code Editing

- Running tests

  • Postman Note: Pode utilizar o Localhost pelo http://localhost/3000/ ou pelo endereço do Heroku Deploy

🤝 Contributing

Este Projeto é para fins de estudo através do Projeto {Reprograma} com apoio do Projeto M.I.N.As do Porto Digital Recife.

Fique a vontade em contribuir! Me mostre e me ensine o que você sabe!

Todo o tipo de contribuição será bem vindo!

  • 🐛Encontrar e relatar problemas;
  • 📥 Envie PRs para ajudar a resolver problemas ou adicionar recursos.
    Note Crie uma branch para realizar as alterações : git checkout -b feature/nome-da-sua-branch

Useful information

1- Fechar porta em uso ou saber quais estão sendo utilizadas;

2- Problemas com a DNS no computador;

Licença

Este projeto está sob a licença MIT.