This is an e-commerce API built with Node.js and Express.js, utilizing Supabase for data storage. The API supports product management, cart management, order placement, and user authentication.

Table of Contents

• Documentation
• Installation
• Endpoints
  • Authentication
  • Product Management
  • Cart Management
  • Order Placement

Documentation

API documentation is available at /api-docs.

Installation

1. Clone the repository:

   git clone https://github.com/usama739/Ecommerce-API.git
   cd ecommerce-api

2. Install dependencies:

   npm install

3. Create a .env file in the root directory and add your environment variables:

   SUPABASE_URL=your_supabase_url
   SUPABASE_KEY=your_supabase_key

4. Start the server:

   npx nodemon server.js
   

Once the server is running, you can use tools like Postman to interact with the API endpoints.

Endpoints

Authentication

1. Register a New User

   URL: POST /api/auth/register

   Description: Registers a new user.

   

2. Login

   URL: POST /api/auth/login

   Description: Logs in a user.

   

Product Management

1. Create a New Product

   URL: POST /api/products

   Description: Creates a new product.

   

2. Retrieve or Filter Products by Category

   URL: GET /api/products?category=CategoryName

   Description: Retrieves products filtered by category.

   

3. Update a Product

   URL: PUT /api/products/:id

   Description: Updates the details of an existing product.

   

4. Delete a Product

   URL: DELETE /api/products/:id

   Description: Deletes a product.

   

Cart Management

Note: Only authenticated users can access and modify their cart information.

1. Create a New Cart

   URL: POST /api/cart

   Description: Creates a new cart for a user.

   

2. Add Product to Cart

   URL: POST /api/cart/add

   Description: Adds a product to the user's cart with a specified quantity.

   

3. Remove Product from Cart

   URL: POST /api/cart/remove

   Description: Removes a product from the user's cart.

   It will generate an error if the user is not authenticated.

   

   Product will be removed if authenticated user makes a request

   

4. Get Cart Contents

   URL: GET /api/cart/:userId

   Description: Retrieves the contents of the user's cart.

   

Order Placement

Note: Only authenticated users can access and modify their order information.

1. Place an Order

   URL: POST /api/orders

   Description: Places an order by converting the contents of the user's cart into an order.

   

2. Get Order Details

   URL: GET /api/orders/:id

   Description: Retrieves order details by order ID.