officialozioma / bookly Goto Github PK

0.0 1.0 0.0 56 KB

This is a RESTful API where users can search for books related to programming, IT or technology, from https://itbook.store. Registered users can also add books to their favourite list.

Dockerfile 0.50% JavaScript 99.50%

api itbooks nodejs restful-api

bookly's Introduction

Bookly-REST-API

Bookly This is a RESTful API where users can search for books related to programming, IT or technology, from https://itbook.store. Registered user can also add books to their favourite list.

Bookly-REST-API
License

Features

Users can create their profiles (token-based authentication)
Users can search for books by title, author or keywords
Users can view details of a particular book
Users can add books to their favorite list
Users can remove books from their favorite list
Users can view their list of favorite books

Tech used

Runtime environment

Node.js

API for books

IT Book Store API

Database

MongoDB

Containerized tool

Docker

How to get the project

Using Git (recommended)

Navigate & open CLI into the directory where you want to put this project & Clone this project using this command.

git clone [email protected]:OfficialOzioma/bookly.git

Using manual download ZIP

Download repository
Extract the zip file, navigate into it & copy the folder to your desired directory

Setting up environments

Inside the project folder
You will find a file named .env.example
Rename the file to .env & change the values of the variables in file, this include the MONGODB_URL and DB_NAME.
You can also change the PORT variable to your desired port number
Create a database in MongoDB & name it as you like.
run npm install on the terminal to install all dependencies.
start the server using npm run dev or npm start
You can now access the API at http://localhost:3000

Run the project using docker

To build docker image
```
docker compose build --no-cache
```
To run the containers in detached mode (wait for a while for database connection)
```
docker compose up -d
```
To view running containers
```
docker container ps
```
To view API logs
```
docker logs booksearch-api-c
```
To run tests, first enter within the API container
- on windows CMD (not switching to bash)
```
docker exec -it booksearch-api-c /bin/sh
```
- on windows CMD (after switching to bash)
```
docker exec -it booksearch-api-c //bin//sh
```
  or
```
winpty docker exec -it booksearch-api-c //bin//sh
```
now run test command
```
npm test
```
To exit from API container, press Ctrl+D on terminal
To stop the containers
```
docker compose down
```

API endpoints

Indication

Authentication required
Authentication not required

User related

Resgister: POST localhost:3000/user/register
Login: POST localhost:3000/user/login
Logout: DELETE localhost:3000/user/logout
Refresh token: POST localhost:3000/user/me/tokenRefresh
Get loggedin user's info: GET localhost:3000/user/me/getLoggedInUserData

Book related

Search for books: GET localhost:3000/book/search/:searchParams/:page
Get details of a particular book: GET localhost:3000/book/getBookDetails/:bookId
Add a book to user's favourite list: POST localhost:3000/book/addToFavourite
Remove a book from user's favourite list: DELETE localhost:3000/book/removeFromFavourite
Get user's favourite book list: GET localhost:3000/book/getFavouriteBooks