Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sabaurgup/book-app
https://github.com/sabaurgup/book-app
Last synced: about 6 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/sabaurgup/book-app
- Owner: SabaUrgup
- Created: 2023-01-25T16:58:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T18:21:26.000Z (almost 2 years ago)
- Last Synced: 2023-11-04T15:27:36.598Z (about 1 year ago)
- Language: JavaScript
- Size: 110 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Book-App
Book Application
It is a repo created by learning and running the medium article[^1] from the developer named Steven Victor
> A Simple Book RestAPI
## Technologies Used
[node]: (https://nodejs.org)
- [Node.js](node)
- [PostgreSQL](node)
- [Express.js](https://expressjs.com).
- [ESLint](https://eslint.org/).
- [Airbnb](https://www.npmjs.com/package/eslint-config-airbnb).
## Installations
#### Getting started
- You need to have Node and NPM installed on your computer.
- Installing [Node](node) automatically comes with npm.
#### Clone
- Clone this project to your local machine
#### Setup
- Installing the project dependencies
> Run the command below
```shell
$ npm install
```
- Start your node server
> run the command below
```shell
$ npm run dev
```
- Use `http://localhost:8000` as base url for endpoints
## API Endpoints
| METHOD | DESCRIPTION | ENDPOINTS |
| ------ | --------------------------------------- | ------------------------- |
| POST | Add a book | `/api/v1/books` |
| GET | Get all the book | `/api/v1/books` |
| PUT | Update the details of a book | `/api/v1/books/:bookId` |
| GET | Get a book particular book | `/api/v1/books/:bookId` |
| DELETE | Remove a book | `/api/v1/books/:bookId` |
## Resources
Some websites were consulted for library and commands.
* victorsteven Medium[^1]
* [victorsteven Github](https://github.com/victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate)
[^1]: [victorsteven Medium](https://medium.com/@victorsteven/restful-api-with-nodejs-express-postgresql-sequelize-travis-mocha-coveralls-and-code-climate-f28715f7a014)