Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/amanmandal-m/triveous-ecommerce-backend

Our backend powers an e-commerce platform. It handles user management, product operations, shopping carts, order processing, and more. Built with Node.js, Express.js, and MongoDB, it's designed for scalability and integration with your frontend.
https://github.com/amanmandal-m/triveous-ecommerce-backend

aws-ec2 bcrypt cors dotenv ejs express-js jsonwebtoken mongoose node-js nodemailer twillio

Last synced: about 2 months ago
JSON representation

Our backend powers an e-commerce platform. It handles user management, product operations, shopping carts, order processing, and more. Built with Node.js, Express.js, and MongoDB, it's designed for scalability and integration with your frontend.

Awesome Lists containing this project

README 

        
Triveous Ecommerce Backend



Triveous Ecommerce Backend is the server-side component of our robust e-commerce platform, powering everything from user authentication to order processing. Built with Node.js, Express.js, and MongoDB, it provides the essential backend functionality for a complete online shopping experience.



## Table of Contents



- [Features](#features)

- [Technology Stack](#technology-stack)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

  - [Configuration](#configuration)

  - [Running the Server](#running-the-server)

- [API Documentation](#api-documentation)

- [Database Schema](#database-schema)

- [Folder Structure](#folder-structure)



## Features



Our Triveous Ecommerce Backend offers a comprehensive set of features to drive your e-commerce platform:



- **User Management:**

  - User registration with email verification.

  - Secure user authentication using JSON Web Tokens (JWT).



- **Category and Product Management:**

  - Create, update, and delete product categories.

  - Manage product details including title, price, description, and availability.



- **Shopping Cart:**

  - Add products to the cart.

  - View, update quantities, and remove items from the cart.



- **Order Processing:**

  - Place orders with automatic calculation of order totals.

  - Order history and order details retrieval.

  - Send email confirmations for order placements and updates.



- **Error Handling:**

  - Robust error handling and validation for data integrity.



- **RESTful APIs:**

  - Well-documented RESTful APIs for seamless integration with frontend applications.



## Technology Stack



Our backend leverages the following technologies to provide a secure and scalable e-commerce solution:



- **Node.js:** A server-side JavaScript runtime for building fast and scalable network applications.



- **Express.js:** A minimal and flexible Node.js web application framework that simplifies the development of robust APIs.



- **MongoDB:** A NoSQL database for efficient data storage and retrieval.



- **Mongoose:** An elegant object modeling library for MongoDB, making it easy to manage database interactions.



- **JSON Web Tokens (JWT):** Secure user authentication and authorization.



- **Nodemailer:** A powerful library for sending email notifications.



## Getting Started



### Prerequisites



Before you start, ensure you have met the following requirements:



- **Node.js:** Install Node.js (LTS version) from [nodejs.org](https://nodejs.org/).



### Installation



1. **Clone the repository:**



   ```shell

   git clone https://github.com/Amanmandal-M/Triveous-Ecommerce-Backend.git



2. **Install Dependencies:**



    ```shell

    cd triveous-ecommerce-backend

    npm install / npm i



### Configuration



1. **Database Setup:** Configure the MongoDB connection by providing your database URI in the `.env` file:



    ```shell

    MONGO_URI = your_mongodb_uri



2. **Email Configuration:** Set up your email service credentials in .env for sending email notifications. For example, with Gmail:



    ```shell

    EMAIL_ID  = your_email_id

    GOOGLEKEY = your_google_key



### Running the Server



Start the backend server:



    ```shell

    npm start

    # or

    node server.js

    # or

    nodemon server.js

    # or

    npm run start

    # or

    npm run server



## API Documentation



Our API is thoroughly documented to help you integrate the backend with your frontend. For detailed information, please refer to the [API documentation](docs/apiDocs.md).







### Swagger API Docs :  click here







## Database Schema



To understand the data structure of our MongoDB database, explore the [Database Schema](docs/Database_Schema.png).



## Folder Structure



We maintain a clean and organized folder structure for easy navigation and development. Get familiar with it in the [Folder Structure](docs/FolderStructure.md) document.



Made with ❤️ by the Triveous Ecommerce Team