https://github.com/victorsteven/book-app-nodejs-postgresql-travis-coveralls-code-climate
This is a nodejs application
https://github.com/victorsteven/book-app-nodejs-postgresql-travis-coveralls-code-climate
Last synced: 26 days ago
JSON representation
This is a nodejs application
- Host: GitHub
- URL: https://github.com/victorsteven/book-app-nodejs-postgresql-travis-coveralls-code-climate
- Owner: victorsteven
- Created: 2019-04-17T21:14:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-21T01:39:56.000Z (about 6 years ago)
- Last Synced: 2025-04-06T14:39:15.871Z (about 2 months ago)
- Language: JavaScript
- Size: 313 KB
- Stars: 50
- Watchers: 3
- Forks: 42
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Book Application
[](https://travis-ci.org/victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate) [](https://coveralls.io/github/victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate?branch=master) [](https://codeclimate.com/github/victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate/maintainability)
> A Simple Book RestAPI
## Getting Started
> [[Technologies](#technologies-used) · [Testing Tools](#testing-tools) · [Installations](#installations) · [API Endpoints](#api-endpoints) · [Tests](#tests) · [Author](#author)
## 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).
## Testing Tools
- [Mocha](https://mochajs.org/).
- [Chai](https://chaijs.com).
## 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 `[email protected]:victorsteven/Book-app-NodeJS-PostgreSQL-Travis-Coveralls-Code-Climate.git`
#### 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` |
## Tests
- Run test for all endpoints
> run the command below
```shell
$ npm run test
```
## Author
- Steven Victor
medium: medium.com/@victorsteven
twitter: twitter.com/stevensunflash
linkedin: linkedin.com/in/stevenchikodi