Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matigumma/gostack-11-node.js
GoStack 11 - Node.js concepts
https://github.com/matigumma/gostack-11-node.js
Last synced: about 1 month ago
JSON representation
GoStack 11 - Node.js concepts
- Host: GitHub
- URL: https://github.com/matigumma/gostack-11-node.js
- Owner: matigumma
- Created: 2020-04-07T00:00:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:57:03.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T06:39:17.530Z (9 months ago)
- Language: JavaScript
- Size: 1.09 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to GoStack11 · NodeJs api 👋
> This is an example of api to handle repositories (in memory) just for practice.
### ✨ [Demo](https://gostack11-nodejs-api.herokuapp.com/)
## Install
```sh
yarn install
```
## Usage
```sh
yarn run start
```
## Run tests
```sh
yarn run test
```
## API
```diff
! Description: Return an array with repositories
+ [METHOD : path] GET : /repositories
Result: []
-
! Description: Add a new repo object
BODY: {
"title": String,
"url": String,
"techs": Array[]
}
+ [METHOD : path] POST : /repositories
Result: {
"id": String,
"title": String,
"url": String,
"techs": Array[],
"likes": Number
}
-
! Description: Modify an existing repo by id
PARAMS: "id"
BODY: {
"title": String,
"url": String,
"techs": Array[]
}
+ [METHOD : path] PUT : /repositories/:id
Result: {
"title": String,
"url": String,
"techs": Array[],
}
-
! Description: Delete an existing repo by id
PARAMS: "id"
+ [METHOD : path] DELETE : /repositories/:id
Result: status(204) / No Content
-
! Description: Increments "likes" by 1 of an existing repo by id
PARAMS: "id"
+ [METHOD : path] POST : /repositories/:id/like
Result: {
"id": String,
"title": String,
"url": String,
"techs": Array[],
"likes": Number
}
```
## Author
👤 **Matias Gummá**
- Github: [@matigumma](https://github.com/matigumma)
- LinkedIn: [@matiasgumma](https://linkedin.com/in/matiasgumma)
## Show your support
Give a ⭐️ if this project helped you!
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_