bethimanideep/triveous

Ecommerce API

Overview

This project will deliver a comprehensive e-commerce API set that enables seamless product and category management, user authentication, secure cart management, and order processing. The integration of MongoDB as the database and token management system ensures efficient data storage and user authentication with minimal server-side setup.

Backend Deploy

https://triveous-omega.vercel.app/

Video Demonstration

https://drive.google.com/file/d/1_IRpANot-MHxEp57BjINnRtRTm7U7jCL/view?usp=sharing

Table of Contents

• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • [Authentication] (#authentication)
  • Routes
• API Documentation

Features

• User registration and login with JWT authentication.
• Product management: Add, retrieve, and search products by category.
• Cart management: Add, remove, and update product quantities in the cart.
• Order processing: Place orders and retrieve order history.

Technologies Used

• Node.js: A JavaScript runtime for server-side development.
• Express.js: A web application framework for Node.js.
• MongoDB: A NoSQL database for storing data.
• JWT: JSON Web Tokens for authentication.
• Swagger: API documentation tool.
• Other Dependencies: Various Node.js libraries and modules.

Getting Started

Prerequisites

Before getting started, make sure you have the following installed:

• Node.js: Download Node.js
• MongoDB: Download MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/bethimanideep/triveous.git
   

2. Navigate to the project directory:

   cd E-commerce
   npm-i
   

3. Install dependencies:

   npm install express mongoose bcrypt jsonwebtoken swagger-jsdoc swagger-ui-express
   

4. Application Start

   npm run server
   

Port for the Node.js server

port=anyport

MongoDB connection URI

mongodb=mongodburl

Secret key for JWT token generation

secret=yoursecret

Usage

Authentication

To use protected routes, you must authenticate by obtaining a JWT token. Use the /users/login route to log in and get the token.

Routes

User Routes

User Registration: POST /users/register
User Login: POST /users/login

Product Routes

Add a Product: POST /product/add-product
Get Product Categories: GET /product/categoryproducts
Get Product by ID: GET /product/getproduct/{id}

Cart Routes

Add to Cart: POST /cart/add-to-cart/
Remove from Cart: DELETE /cart/remove/{productId}
Get Cart Contents: GET /cart/cartdata
Update Quantity in Cart: PUT /cart/update-quantity

Order Routes

Place an Order: POST /orders/place-order
Get Order Details: GET /orders/allorders
Get Order by ID: GET /orders/getorder/{orderId}

NOTE: API rate limiting to prevent abuse and maintain server stability.

API RATE LIMIT used for the amount of time and no.of req valid for your application.

middleware --> express-rate-limit

Example Which I set in this assignment:

• max: 6, //no. of req users can make within the time
• windowMs: 10000 // time frame in (ms)

After 10000ms you get the Error: "Too many requests, please try again later" with a 429 status code if you try to make more than 6 requests.

So Finally you can make 6 requests in 10 seconds.

Contributing

We welcome contributions from the community! Check out our Contributing Guidelines to get involved.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

We'd like to thank all of our contributors and supporters who have helped make Fanztar a reality.

Contact

For any inquiries or feedback, please contact us at bethimanideep@gmail.com.