E-commerce API

React E-Commerce Site API (Front End & Admin Panel)

This is the API for the React E-Commerce Site. This API is built with Node.js, Express.js, and MongoDB.

Installation

1. Clone the repo sh git clone https://gitlab.com/amit_chandrakar/e-commerce-backend.git
2. Install NPM packages sh npm install
3. Run command to create .env file sh cp .env.example .env
4. Enter your MongoDB Atlas URI in .env JS MONGO_URI = 'ENTER YOUR MONGO URI';
5. Run the app sh npm start
6. Test the API with Postman or Insomnia. The API documentation URL is https://documenter.getpostman.com/view/4333189/2s9YRCVAhD

This API includes following pages on Admin Panel

• Dashboard Pages
  • Dashboard (V2)
  • Users (V2)
    • Users (V2)
    • Roles (V2)
    • Permissions (V2)
  • Categories (V1)
  • Subcategories (V1)
  • Brands (V1)
  • Products (V1)
  • Orders (V1)
  • Invoices (V1)
  • Payments (V1)
  • Coupons (V2)
  • Reports (V2)
  • Settings
    • App Settings (V2)
    • Payment Settings (V2)
    • Social Settings
    • Email Settings (V2)
    • SMS Settings (V2)
    • Language Settings (V3)
    • Front page settings (V1)
    • Front Theme Settings (V1)
    • Admin Theme Settings
    • Tax Settings (V1)

This API includes following pages on Admin Panel

• Dashboard (V2)
• Users (V2)
  • Users (V2)
  • Roles (V2)
  • Permissions (V2)
• Categories (V1)
• Subcategories (V1)
• Brands (V1)
• Products (V1)
• Orders (V1)
• Invoices (V1)
• Payments (V1)
• Coupons (V2)
• Reports (V2)
• Settings
  • App Settings (V2)
  • Payment Settings (V2)
  • Email Settings (V2)
  • SMS Settings (V2)
  • Tax Settings (V1)
  • Language Settings (V3)
  • Front page settings (V1)
  • Front Theme Settings (V1)
  • Admin Theme Settings
  • Social Settings

This API includes following pages on Front Website

• Home Page (V1)
• Products Listing Page with filters (V1)
• Product Details (V1)
• Cart (V1)
• Checkout (V1)
• Order Success (V1)
• User Profile (V1)
• User Orders (V1)
• User Addresses (V1)
• Product Reviews (V2)
• User Auth (Login, Register, Forgot Password, Reset Password ) (V1)

Features of this API

The following features has been planned for this API.

Feature	Status
File/Image upload
Seeder
Authentication Login Register Forgot password Reset password Email verification Social login
Integrations Docker CI/CD Linting and Code Formatting Code Documentation
Payment gateway Stripe Paypal Razorpay
SMS Gateway
Google recaptcha
User Activity Logs
User Roles and Permissions

Node packages used

These are the packages used in this project. Click on the package name to go to the package page.

Name	Description	Package Link	Status
Express	Fast, unopinionated, minimalist web framework for node.
Mongoose	Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.
Dotenv	Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env.
Nodemon	Nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.
Morgan	HTTP request logger middleware for node.js.
Cors	CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.
Winston	A logger for just about everything.
Slugify	Slugifies string with replacement.
Razorpay	Razorpay Node.js client for API v1 and v2.
Nodemailer	Send e-mails from Node.js – easy as cake! 🍰✉️
Multer	Multer is a node.js middleware for handling multipart/form-data, which is primarily used for uploading files.
Jsonwebtoken	An implementation of JSON Web Tokens.
Eslint	A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.
Husky	Husky can prevent bad git commit, git push and more 🐶 woof!
Migrate-mongo	The MongoDB CLI for Migrations.
Bcrypt	A library to help you hash passwords.

API Documentation

The API documentation URL is https://documenter.getpostman.com/view/4333189/2s9YRCVAhD

License

This is an open source project. Feel free to do whatever you want with it. 🤘😎🤘