Order Management

1. Create a New Order

   • Endpoint: /api/orders
   • Method: POST
   • Sample Request Body:

     {
       "email": "level2@programming-hero.com",
       "productId": "5fd67e890b60c903cd8544a3",
       "price": 999,
       "quantity": 1
     }
     

2. Retrieve All Orders

   • Endpoint: /api/orders
   • Method: GET

3. Retrieve Orders by User Email

   • Endpoint: /api/orders?email=email@example.com
   • Method: GET

Data Models

Product Model

• name: string
• description: string
• price: number
• category: string
• tags: array of strings
• variants: array of objects
  • type: string
  • value: string
• inventory: object
  • quantity: number
  • inStock: boolean

Order Model

• email: string
• productId: ObjectId
• price: number
• quantity: number

Validation

Using Zod for request validation:

• Ensure product and order data adhere to the specified structure.
• Provide meaningful error messages on validation failure.

Error Handling

• Handle validation errors with meaningful messages.
• Handle insufficient quantity errors.
• Handle not found errors for products and orders.
• Gracefully handle unknown routes.

Setup Instructions

1. Clone the Repository

   git clone https://github.com/Tanzeebul-Tamim/TS_Mongoose_E-commerce_API
   

2. Install Dependencies

   npm install
   

3. Environment Variables

   • Create a .env file in the root directory.
   • Add the following variables:

     PORT=5000
     MONGODB_URI=your_mongodb_connection_string
     

4. Run the Application

   npm run dev
   

5. Access the API

   • The API will be available at http://localhost:5000

Linting

• Ensure code quality using ESLint.
• Run linting:

  npm run lint
  

• Automatically fix linting issues:

  npm run lint:fix
  

Format

• Format your code using Prettier.
• Run Prettier:

  npm run format
  

Live Deployment

The API is deployed at vercel and can be accessed through here