Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nadyluna/reprograma-backend-projetofinal
Projeto Final _Reprograma
https://github.com/nadyluna/reprograma-backend-projetofinal
api cadastrar-alunos cadastrar-faculdade crud-api expressjs heroku javascript mongodb mongoosejs node-js
Last synced: about 1 month ago
JSON representation
Projeto Final _Reprograma
- Host: GitHub
- URL: https://github.com/nadyluna/reprograma-backend-projetofinal
- Owner: NadyLuna
- License: mit
- Created: 2020-11-28T19:47:01.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-13T14:40:06.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T12:04:20.643Z (about 1 month ago)
- Topics: api, cadastrar-alunos, cadastrar-faculdade, crud-api, expressjs, heroku, javascript, mongodb, mongoosejs, node-js
- Language: JavaScript
- Homepage:
- Size: 2.2 MB
- Stars: 13
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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.
### :checkered_flag: 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
- [x] [dotenv-safe 8.2.0](https://https://www.npmjs.com/package/dotenv-safe)
- [x] [express 4.17.1](https://https://expressjs.com/pt-br/)
- [x] [mongoose 5.10.17](https://https://mongoosejs.com/docs/)
- [x] [nodemon 2.0.6](https://https://www.npmjs.com/package/nodemon)
- [x] [validator 13.5.2](https://www.npmjs.com/package/validator)
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](https://www.mongodb.com/cloud/atlas); Para criar ou utilizar um Cluster e inserir a String de Conexão no app.js. a `URL do MONGO_URL` fica "guardada" no `.env`conforme demonstrado no `.env.example`.
```
* String de conexão com Mongo Atlas
mongoose.connect(`${process.env.MONGODB_URL}`, {
useNewUrlParser: true,
useUnifiedTopology: true
});
```
#### - Deploy
#### - Language, Software and Database
  
#### - Code Editing
- [x] [Visual Code Studio](https://https://code.visualstudio.com/)
#### - Running tests
- [x] [Postman](https://www.postman.com/)
**Note:** Pode utilizar o Localhost pelo `http://localhost/3000/` ou pelo endereço do Heroku Deploy
### :handshake: **Contributing**
Este Projeto é para fins de estudo através do Projeto [{Reprograma}](https://reprograma.com.br/) 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](https://medium.com/@daniloassis.ti/como-finalizar-um-processo-em-aberto-no-windows-525652152902) em uso ou saber quais estão sendo utilizadas;
2- Problemas com a [DNS](https://use.opendns.com/) no computador;
#### Licença
Este projeto está sob a licença [MIT](./LICENSE.md).