/BookStoreAPI

BookStoreAPI project

Primary LanguageJavaScript

BookStoreAPI 📚

BookStoreAPI is a RESTful API for managing books and users in a bookstore. It provides endpoints to perform CRUD operations on books and users, as well as features like user authentication, password reset, and photo upload. 🌟

Dependencies 📦

This project utilizes the following dependencies:

  • 🚀 express : A fast and minimalist web framework for Node.js.
  • 🤝 express-async-handler : A utility to handle asynchronous errors in Express
  • 🍃 mongoose : A MongoDB object modeling tool for Node.js.
  • 🔄 nodemon : A development utility for automatically restarting the server
  • 🔒 bcryptjs : A library for hashing and comparing passwords securely.
  • ️⚙️ dotenv : A module for loading environment variables from a .env file.
  • ✅ joi : A validator library for validating and sanitizing data. middleware.
  • 🎫 jsonwebtoken : A library for generating and verifying JSON Web Tokens (JWT).
  • 🛡️ helmet : A middleware for securing Express apps with various HTTP headers.
  • 🔐 joi-password-complexity : A plugin for Joi to enforce password complexity rules.
  • 📷 multer : A middleware for handling file uploads.
  • 📧 nodemailer : A module for sending emails. during development.

Features ✨

The BookStoreAPI project provides the following features:

  • User Management 👥:
  • Author Management ✍️:
  • Book Management 📖:
  • Authentication and Password Reset 🔐:
  • Photo Upload 🖼️:
  • Seeding 🌱:

Endpoints

Authentication

  • Register a new user
    • POST /api/auth/register
  • Login user
    • POST /api/auth/login

Authors

  • Get all authors
    • GET /authors
  • Get a specific author by ID
    • GET /authors/:id
  • Create a new author (admin only)
    • POST /authors/add
  • Update an existing author (admin only)
    • PUT /authors/update/:id
  • Delete an author by ID (admin only)
    • DELETE /authors/delete/:id

Books

  • Get all books
    • GET /books
  • Get a specific book by ID
    • GET /books/:id
  • Create a new book (admin only)
    • POST /books/add
  • Update an existing book
    • PUT /books/update/:id
  • Delete a book by ID (admin only)
    • DELETE /books/delete/:id

Image Upload

  • Upload image
    • POST /upload

Users

  • Update user
    • PUT /users/:id
  • Get all users (admin only)
    • GET /users
  • Get user by ID
    • GET /users/:id
  • Delete user by ID
    • DELETE /users/:id

Getting Started 🚀

To get started with the BookStoreAPI project, follow these steps:

  1. Clone the repository: https://github.com/husamahmud/BookStoreAPI.git
  2. Install the dependencies: npm install
  3. Set up the environment variables by creating a .env file based on the provided .env.example file. 
     MONGO_URI=mongodb://localhost/BookStoreDB
 PORT=3000
 NODE_ENV=development
 SECRET_KEY=secret
 BASE_URL=http://localhost:3000
 USER_EMAIL=example@gmail.com
 USER_PASSWORD=app-password
  4. Run the application: npm start (with nodemon for development)

Make sure you have MongoDB set up and running, and update the MongoDB connection URL in the .env file.

Author ✍️