https://github.com/anaisateodoro/crud-comunicacao-students
Projeto Livre - API ComunicAção
https://github.com/anaisateodoro/crud-comunicacao-students
Last synced: 4 months ago
JSON representation
Projeto Livre - API ComunicAção
- Host: GitHub
- URL: https://github.com/anaisateodoro/crud-comunicacao-students
- Owner: anaisateodoro
- Created: 2021-07-10T04:12:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-10T23:57:35.000Z (over 4 years ago)
- Last Synced: 2025-02-24T01:16:36.436Z (8 months ago)
- Language: JavaScript
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### General info - API ComunicAção
ComunicAção API is a student REST API made to show frequency students.
#### The student Object 🍵
| Properties | Description | Type |
|:----------- |:---------------|:--------|
|nome| the student name | String|
|nascimento| the description | String |
|responsaveis|responsaveis associated with the student |String |
|telefone|time to send a message | Number |
|comments|any comments posted about the student |Array of String |
#### Routes ⚡
| Routes | HTTP Methods| Description
|:------- |:---------------|:--------------
| /student | GET | Displays all student
| /student | POST | Creates a new student
| /student | DELETE | Deletes all student
|/student/:name| GET | Displays a specific student, given its name
|/student/:name| POST | Adds a comment to a specific student, given its name
|/student/:name| DELETE | Deletes a specific student, given its name
### Technologies
Project is created with:
* Node version: 12.14.1
* Express version: 4.17.1
* Mongoose version: 5.9.25
* MongoDB Atlas
## Arquitetura
Arquitetura MVC
|
\--📂 crud-api-comunicacao
| README.md
| .env
| .gitignore
| package-lock.json
| package.json
| **server.js**
\--📂 node_modules
\--📂src
|📂---controller
| **student.js**
|
📂---data
| **database.js**
|
📂---models
| **student.js**
|
📂---public
| **student.js
style.css**
|
|
📂---routes
| **index.js
student.js**
#### 👉 Deployed at: https://crud-api-comunicacao-students/herokuapp.com
> Note: heroku can load the page. Please let me know if you find any bugs or errors at anaisateodoro@hotmail.com
### Setup
To run this project locally, clone repo and execute in command prompt:
```
$ cd crud-api-comunicacao
$ npm install
$ npm start or nodemon server.js
```
### Next Steps
- Populate send a message with SMS (Twilo)
- Make a simple auth using the jsonwebtoken this API
- Make a better markdown ant HTML and style Css
# crud-comunicacao-students