Mini Book Club (Backend Server)

This is the Mini Book Club backend (express API) repo.

• Backend live server: Backend live server

Description

Mini Book Club is a Full-stack application using the MERN stack (MongoDB, Express, React, and Node.JS) This repository contains the backend code for the server of this application. It is a RESTful API built with ExpressJS, MongoDB, and Mongoose.

It's a gift for my wife and her book reading club. My Mini Book Club is a place where you can share notes of your favourite books and also ratings. It allows logged-in users to manage all the books, authors and notes that they own in the database doing full CRUD. Anonymous users can see the books, authors and notes.

Features

• Book Listing: Display a list of books you have read.
• Adding New Entries: Add new book entries with details such as ISBN, title, author, description, review, and rating.
• Review Update: Update book reviews.
• Book Deletion: Delete books along with associated notes.
• Notes: View, add, update and delete notes for each book.

Technical details:

• REST API backend built with ExpressJS, MongoDB, and Mongoose.

• REST API backend with routes that perform all CRUD actions for two models (books and authors).

• Backend validation and centralized error handling the REST API.

• SPA frontend, built with React, consisting of multiple views and implementing all CRUD actions.

• Include sign-up, log-in, and log-out functionality with encrypted passwords and authorization (logged-in users can do additional things).

Express Server Setup

• The server setup is implemented using Express.js, and the configuration is defined in the index.js file.

API Interaction

• When submitting a new book entry, cover images are fetched from the Open Library Covers API using Axios. A fetchAndSaveCover function fetches the images and saves them to the project folder.

Frontend

• Deployed live version: Live demo

• Frontend client repo: Frontend Client Repo

Instructions

To run on your computer, follow these steps:

1. Clone the repository.
2. Install dependencies: npm install.
3. Create a .env file with the following environment variables:
   • PORT=<your-port> (5005)
   • ORIGIN=http:/http://localhost:5173/
   • TOKEN_SECRET=<your-token-secret>
4. Run the application: node server.js.

Environment variables

Hosted on your localhost:

Add the following environment variables in .env files:

Server

• PORT=<your-port> (5005)
• ORIGIN=http:/http://localhost:5173/
• TOKEN_SECRET=<your-token-secret>

Client

• VITE_APP_URL=http://localhost:5005

Creating your own deployment

Backend using adaptable.io

• TOKEN_SECRET=<your-token-secret>
• MONGODB_URI=mongodb+srv://<your-mongodb-atlas-password-+-name-of-db>
• ORIGIN=<your-netlify-app-domain>

Fronted using netlify.app

• CI=false (required for SPA applications deployed on this service to redirect requests to index.html)
• VITE_API_URL=<your-adaptable-app-domain>

API Routes

Books routes

HTTP verb	URL	Request body	Action
GET	/books	(empty)	Returns all the books
POST	/books	JSON	Adds a new book
GET	/books/:booksId	(empty)	Returns the specified book
PUT	/books/:booksId	JSON	Edits the specified book
DELETE	/books/:booksId	(empty)	Deletes the specified book

---

Authors routes

HTTP verb	URL	Request body	Action
GET	/authors	(empty)	Returns all the authors
POST	/authors	JSON	Adds a new author
GET	/authors/:authorsId	(empty)	Returns the specified author
PUT	/authors/:authorsId	JSON	Edits the specified author
DELETE	/authors/:authorsId	(empty)	Deletes the specified author

---

User routes

HTTP verb	URL	Request body	Action
GET	/user/:userId	(empty)	Returns the specified user
PUT	/user/:userId	JSON	Edits the specified user
DELETE	/user/:userId	(empty)	Deletes the specified user

---

Auth routes

HTTP verb	URL	Request Headers	Request Body
POST	/auth/signup	--	{ email, password, name }
POST	/auth/login	--	{ email, password }
GET	/auth/verify	Authorization: Bearer < JWT >	--

---