Project Documentation

Introduction

This project is a **Product Management System** built using modern web technologies. It allows users to create, view, update, and delete products. The application also includes user authentication (signup, login, and profile management).

Technologies Used

• Frontend: React, Next.js, Material-UI
• State Management: Zustand
• API Handling: Axios, React Query
• Form Handling: React Hook Form
• Routing: React Router DOM
• Notifications: React Hot Toast
• Authentication: React Cookie

API Documentation

The application interacts with the following APIs:

Product APIs

• Create Product

  Endpoint: POST /api/product/create
  Headers: x-access-token (User Token)
  Parameters: title (String), description (String), image (File)

• Get Product Details

  Endpoint: GET /api/product/detail/:id
  Headers: x-access-token (User Token)
  Parameters: id (ObjectId)

• List Products

  Endpoint: POST /api/product/list
  Headers: x-access-token (User Token)
  Parameters: page (Number), perpage (Number)

• Delete Product

  Endpoint: POST /api/product/remove
  Headers: x-access-token (User Token)
  Parameters: id (ObjectId)

• Update Product

  Endpoint: POST /api/product/update
  Headers: x-access-token (User Token)
  Parameters: id (ObjectId), title (String), description (String), image (File)

User APIs

• User Signup

  Endpoint: POST /api/user/signup
  Parameters: first_name (String), last_name (String), email (String), password (String), profile_pic (File)

• User Login

  Endpoint: POST /api/user/signin
  Parameters: email (String), password (String)

• User Profile Details

  Endpoint: GET /api/user/profile-details
  Headers: x-access-token (User Token)

Application Routes

• Home Page

  /

• Add Product

  /cms/create

• All Products

  /cms/list

• Product Details

  /cms/details/:id

• User Login

  /auth/login

• User Signup

  /auth/signup

Dependencies

Below is the list of dependencies used in this project:

• @emotion/react, @emotion/styled
• @mui/icons-material, @mui/material
• @tanstack/react-query
• axios
• next, react, react-dom
• react-bootstrap-sweetalert
• react-cookie
• react-hook-form
• react-hot-toast
• react-router-dom
• zustand

Conclusion

This documentation provides a comprehensive overview of the project, including the technologies used, API details, application routes, and dependencies. For further assistance, refer to the codebase or contact the development team.