Skip to content

nisharga/Simple_Book_Catalog_Backend

Repository files navigation

Simple Book Catalog Backend

Description

The Simple Book Catalog Backend is a robust application focused on enabling CRUD (Create, Read, Update, Delete) operations, complex pagination, filtering, and global API error handling. This project employs Redux Toolkit to manage state and facilitates the backend functionalities for a book catalog website.

Features

CRUD Operations: Manage Create, Read, Update, and Delete operations efficiently. Complex Pagination: Navigate through extensive data sets with ease using sophisticated pagination techniques. Filtering: Seamlessly filter and search for books using specific parameters. Global API Error Handling: Effectively manage and handle errors that occur during API requests.

Usage To get started, ensure you have Node.js and Yarn installed. Then, follow these steps:

Installation:

Clone the repository

git clone https://github.com/your-username/simple_book_catalog_backend.git

Navigate to the project directory

cd simple_book_catalog_backend

Install dependencies

yarn install

Run the Application:

yarn start

Testing:

Run the available test scripts to ensure everything is working as expected.

Technologies Used

Node.js: JavaScript runtime

Redux Toolkit: State management library

Express.js: Web application framework for Node.js

Mongoose: MongoDB object modeling tool

TypeScript: Superset of JavaScript that adds static typing

Prettier and ESLint: Code formatting and linting tools for maintaining code quality

Other dependencies: dotenv, cookie-parser, cors, http-status, zod, and more as listed in the package.json

Scripts

Start: Initiates the server using ts-node-dev.

Linting & Prettifying: Scripts to check and fix linting and code formatting issues.

Lint-Staged: Automatically lints and prettifies staged files on commit using Husky. License

This project is licensed under the ISC License - see the LICENSE file for details.