/e-shopee

E-Shopee is an open-source e-commerce platform designed to help businesses set up and manage their online stores. With E-Shopee, you can easily create product listings, process orders, and provide a seamless shopping experience for your customers.

Primary LanguageEJS

E-Shopee

E-Shopee is an open-source e-commerce platform designed to help businesses set up and manage their online stores. With E-Shopee, you can easily create product listings, process orders, and provide a seamless shopping experience for your customers.

Table of Contents

Features

  • Product Management: Create, update, and delete product listings with ease.
  • Order Processing: Manage customer orders and track their status.
  • User Authentication: Securely authenticate users for a personalized shopping experience.
  • Shopping Cart: Allow customers to add and remove items from their cart.
  • Payment Integration: Integrate with popular payment gateways to process transactions.
  • Responsive Design: Ensure your store looks great on both desktop and mobile devices.
  • Customization: Easily customize the look and feel of your online store.

Getting Started

Prerequisites

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

  • Node.js and npm installed.
  • MongoDB database set up and running.
  • API keys for any payment gateways you plan to use (e.g., Stripe, PayPal).

Installation

  1. Clone the repository:

    git clone https://github.com/prabhath-kj/e-shopee.git

  2. Install dependencies:

    npm install

  3. Configure environment variables:

    Create a .env file in the project root and set the necessary environment variables, including your MongoDB connection string and any API keys.

    PORT=3000
MONGODB_URI=<your-mongodb-uri>
SECRET_KEY=<your-secret-key>
STRIPE_API_KEY=<your-stripe-api-key>
# Add other environment variables as needed

  4. Start the development server:

    npm start
The application should now be running locally at http://localhost:3000.

Usage

  1. Visit http://localhost:3000 in your web browser to access the E-Shopee application.

  2. Register an account or log in if you already have one.

  3. Start managing your products and processing customer orders.

Contributing

We welcome contributions from the community. To contribute to E-Shopee, please follow these steps:

  1. Fork the repository.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature/new-feature

  3. Make your changes and commit them:

    git commit -m "Add new feature"

  4. Push your changes to your fork:

    git push origin feature/new-feature

  5. Create a pull request on the main repository's main branch.

    We will review your contribution and merge it if it meets our guidelines.

Dependencies

Here is a list of project dependencies:

  • @eastdesire/jscolor: Version 2.5.1
  • cloudinary: Version 1.35.0
  • color-convert: Version 2.0.1
  • color-names: Version 2.0.0
  • cookie-parser: Version 1.4.4
  • crypto-js: Version 4.1.1
  • debug: Version 2.6.9
  • dotenv: Version 16.0.3
  • ejs: Version 3.1.8
  • express: Version 4.18.2
  • express-session: Version 1.17.3
  • http-errors: Version 1.6.3
  • moment: Version 2.29.4
  • mongoose: Version 7.0.1
  • morgan: Version 1.9.1
  • multer: Version 1.4.5-lts.1
  • nodemailer: Version 6.9.1
  • pdfkit: Version 0.13.0
  • razorpay: Version 2.8.6
  • slugify: Version 1.6.6
  • twilio: Version 4.8.0

These dependencies are automatically installed when you run npm install