Book Application

A Simple Book RestAPI

Getting Started

[Technologies · Testing Tools · Installations · API Endpoints · Tests · Author

Technologies Used

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

Testing Tools

• Mocha.
• Chai.

Installations

Getting started

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

Clone

• Clone this project to your local machine git@github.com:victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate.git

Setup

• Installing the project dependencies

  Run the command below

  $ npm install

• Start your node server

  run the command below

  $ 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

Tests

• Run test for all endpoints

  run the command below

  $ npm run test

Author

• Steven Victor medium: medium.com/@victorsteven
  twitter: twitter.com/stevensunflash
  linkedin: linkedin.com/in/stevenchikodi