roniepascal

roniepascal /mern-ecommerce-website

A comprehensive MERN stack e-commerce app tutorial covering product management, user authentication, and payment integration

25
23
GitHub
Public

Repository Statistics

Key metrics and engagement data

25
Stars
23
Forks
0
Open Issues
0
Releases
1.92
Engagement Rate
Default branch: main

Timeline

Repository has been active for 2 months

Repository Created

Last Commit
Recently active

README.md

MERN E-commerce Website 🛒

MERN E-commerce

Welcome to the MERN E-commerce Website repository! This project serves as a comprehensive tutorial for building an e-commerce application using the MERN stack. It covers essential features such as product management, user authentication, and payment integration.

Check out the releases here!

Table of Contents

Features

  • Product Management: Add, edit, and delete products with ease.
  • User Authentication: Secure user login and registration process.
  • Payment Integration: Seamless payment processing using PayPal API.
  • Ratings and Reviews: Users can leave feedback on products.
  • Responsive Design: Built with Tailwind CSS for a modern look.
  • State Management: Uses Redux Toolkit for efficient state management.

Technologies Used

This project leverages a variety of technologies:

  • MERN Stack: MongoDB, Express.js, React, Node.js
  • Cloudinary: For image uploads and management.
  • PayPal API: For handling payments.
  • Redux Toolkit: For state management in React.
  • Tailwind CSS: For styling the application.
  • User Reviews: To enhance product credibility.

Installation

To get started with the MERN E-commerce Website, follow these steps:

  1. Clone the Repository:

    bash
    1git clone https://github.com/roniepascal/mern-ecommerce-website.git
  2. Navigate to the Project Directory:

    bash
    1cd mern-ecommerce-website
  3. Install Dependencies:

    For the server:

    bash
    1cd server
    2npm install

    For the client:

    bash
    1cd client
    2npm install
  4. Set Up Environment Variables:

    Create a .env file in the server directory and add the necessary environment variables such as MongoDB URI and PayPal Client ID.

  5. Run the Application:

    Start the server:

    bash
    1cd server
    2npm start

    Start the client:

    bash
    1cd client
    2npm start

Visit http://localhost:3000 to see the application in action!

Usage

Once the application is running, you can:

  • Register a new user account.
  • Log in to your account.
  • Browse through the product catalog.
  • Add products to your cart.
  • Proceed to checkout and make payments using PayPal.
  • Leave ratings and reviews for products you purchase.

For more detailed instructions, refer to the Releases section where you can find specific builds and their corresponding documentation.

Folder Structure

Here's a brief overview of the folder structure:

1mern-ecommerce-website/
2├── client/ # React frontend
3│ ├── public/ # Static files
4│ ├── src/ # React components and assets
5│ └── package.json # Client dependencies
6└── server/ # Node.js backend
7 ├── config/ # Configuration files
8 ├── controllers/ # Request handlers
9 ├── models/ # Database models
10 ├── routes/ # API routes
11 └── package.json # Server dependencies

Contributing

We welcome contributions! If you have suggestions or improvements, please fork the repository and create a pull request.

  1. Fork the project.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a pull request.

License

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

Contact

For any questions or feedback, feel free to reach out:

Thank you for checking out the MERN E-commerce Website!

Explore the releases for more details!