Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 2.28 KB

README.md

File metadata and controls

59 lines (46 loc) · 2.28 KB
Raw

E-Commerce Project using MERN Stack

Welcome to our E-Commerce project built using the MERN (MongoDB, Express, React, Node.js) stack! This document provides an overview of the project's structure, features, and how to set it up for development and testing.

Table of Contents

Introduction

This project is an E-Commerce web application that allows users to browse, search, view product details, add products to their cart, and proceed to checkout. The application includes both the frontend and backend components, with the frontend being built using React and the backend using Node.js and Express.

Features

  • User registration and authentication
  • Product browsing and searching
  • Product categorization and filtering
  • Product details and reviews
  • Shopping cart functionality
  • User profile management
  • Order history and tracking
  • Admin panel for managing products and orders

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js and npm (Node Package Manager)
  • MongoDB (make sure it's up and running)

Installation

  1. Clone this repository: git clone https://github.com/your-username/your-e-commerce-project.git
  2. Navigate to the project directory: cd your-e-commerce-project
  3. Install server dependencies: npm install
  4. Navigate to the client directory: cd client
  5. Install client dependencies: npm install

Configuration

  • Backend: Create a .env file in the root directory and configure your MongoDB connection string, JWT secret, and other environment variables. Example .env:

  • Frontend: In the client/src/config.js file, update the API base URL to match your backend server.

Usage

  1. Start the server: In the project root directory, run npm start.
  2. Start the client: In the client directory, run npm start.
  3. Access the application in your browser at http://localhost:3000.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to submit a pull request.

License

This project is licensed under the MIT License.

Happy coding!