https://github.com/ashishkumarpalai/ecommerce-api-with-nodejs

https://github.com/ashishkumarpalai/ecommerce-api-with-nodejs

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ashishkumarpalai/ecommerce-api-with-nodejs
• Owner: ashishkumarpalai
• Created: 2023-09-01T10:03:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-02T09:24:36.000Z (over 1 year ago)
• Last Synced: 2023-09-03T10:59:43.434Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://ecommerce-k5ri.onrender.com/
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ecommerce Backend API

Welcome to the Ecommerce Backend API! This API supports various e-commerce operations, including product and category listing, product details, cart management, order processing, user registration, and authentication. It's designed to help you build a robust e-commerce platform.

## Getting Started

1. Clone this repository: `git clone https://github.com/your-username/ecommerce-backend.git`

2. Install dependencies: `npm install`

3. Configure environment variables: Create a `.env` file and add your database connection string and other necessary variables.

## API Endpoints

- **Category Listing**: Retrieve a list of product categories.

- **Product Listing**: Retrieve a list of products with essential details.

- **Product Details**: Get detailed information about a specific product.

- **Cart Management**: Add, view, update, or remove items from the cart.

- **Order Placement**: Place an order with products from the cart.

- **Order History**: Fetch the order history for authenticated users.

- **Order Details**: Retrieve detailed information about a specific order.

- **User Registration**: Register new users.

- **User Login**: Authenticate users and obtain a token.

## Database Integration

The API integrates with a MongoDB database to store and manage product data, user cart information, and order details.

## Authentication and Security

User authentication is implemented using JSON Web Tokens (JWT), ensuring secure access to sensitive API endpoints. Unauthorized access is restricted.

## Error Handling

The API handles errors gracefully, providing meaningful error messages and status codes when necessary.

## Project Structure

The project is structured to maintain clean and organized code. Key components include:

- `routes`: Contains route handlers for API endpoints.

- `models`: Defines database models.

- `middleware`: Includes authentication middleware.

- `configs`: Configuration files.