/book-directory-api

This is a Book Directory API built with Nodejs and express js

Primary LanguageJavaScript

BookDirectory-Api

This is a Book Directory API built with Nodejs + express js

Pre-requisites

  • install Nodejs version v18.16.1

Getting Started

  • clone the repository

    git clone <https://github.com/HilaryEmmanuel/BookDirectory-Api.git>

  • Install dependencies

    cd <BookDirectory-Api> npm install

  • Build and run the project

    npm start

Features

  • SignUp
  • Login
  • Logout
  • session based Authentication

Basic CRUD

  • Add a Book
  • Get all Books
  • Get a Book
  • Update a Book
  • Delete a Book

Testing

  • all Endpoints are tested

Major Dependencies

  • Express js - the core of the API
  • Postgresql - the Relational database mangement system used
  • pg-promise - the database driver for postgresql
  • supertest & mocha - for testing
  • pg-session - the session store
  • passportjs - the Authentication middleware

Api Documentation