https://github.com/mickaelandrieu/bookstore-node-rest-api
A simple but functional REST API to manage a Book Store using Node.js and Express.js (for educational purposes)
https://github.com/mickaelandrieu/bookstore-node-rest-api
Last synced: 3 months ago
JSON representation
A simple but functional REST API to manage a Book Store using Node.js and Express.js (for educational purposes)
- Host: GitHub
- URL: https://github.com/mickaelandrieu/bookstore-node-rest-api
- Owner: mickaelandrieu
- License: mit
- Created: 2020-12-01T09:43:51.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-18T14:43:10.000Z (almost 5 years ago)
- Last Synced: 2025-02-03T22:38:32.547Z (8 months ago)
- Language: JavaScript
- Size: 558 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Book Store Node.js (Express.js) REST API
## Installation
```
git clone https://github.com/mickaelandrieu/bookstore-node-rest-api.git
cd bookstore-node-rest-api
npm i
```
## Endpoints
### Books
* `/books`
* `/books/`
### Users
* `/users`
* `/users/`
### Book Store management
* `/borrow//`: borrow a book from the book store as an user
* `/bring-back//`: bring back a book to the book store as an user
## Deploy on Heroku
Create [an account on Heroku](https://signup.heroku.com/) (Free/Hobby tiers is enough) and install [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).
Then, execute the following instruction in the `bookstore-node-rest-api` folder:
```
heroku login
heroku create
git push heroku master
```
And "voila", the REST API is deployed and ready to be tested.
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).