izola1 / book-app

book-app

Project Technologies

Below are the technologies used for the project: [node]: (https://nodejs.org)

• Node.js
• postgreSQL
• Express.js.
• ESLint.
• Airbnb.

Project Testing Tools

The following Testing frameworks/libraries were used:

• Mocha.
• Chai.

Installations

Project Requirements

• You need to have Node and NPM installed on your computer.
• Installing Node automatically comes with npm.

Project Cloning

• You can clone this project to your local machine https://github.com/izola1/book-app.git

Setup

• Installing the project dependencies

  Run the command below

  $ npm install

• To start your node server

  run the command below

  $ npm run dev

• http://localhost:7000 is the base url for the endpoints

Rest API Endpoints

METHOD	DESCRIPTION	ENDPOINTS
POST	To add a book	/api/v1/books
GET	To get details of all books	/api/v1/books
PUT	To update a book detail	/api/v1/books/:id
GET	To get details of a particular book	/api/v1/books/:id
DELETE	To remove a book	/api/v1/books/:id

Tests

• To run test for all endpoints

  run the command below

  $ npm run test