Skip to content

Latest commit

 

History

History
340 lines (259 loc) · 12.8 KB

README.md

File metadata and controls

340 lines (259 loc) · 12.8 KB
Raw

Fusion Electronics: A MERN-Stack E-commerce Application

Welcome to Fusion Electronics, a MERN-Stack E-commerce Application! This project is a working demo of a full-stack web application that was built using the MERN stack (MongoDB, Express.js, React.js, Node.js). It aims to provide a comprehensive example of building a modern e-commerce platform, covering frontend user interface, backend server logic, database management, and integration with third-party libraries.

Table of Contents

  1. Introduction
  2. Live Deployment
  3. User Interface
  4. Features
  5. Technologies Used
  6. Getting Started
  7. Project Structure
  8. Running the Application
  9. Testing the APIs
  10. Swagger API Documentation
  11. Deployment
  12. Containerization
  13. Contributing
  14. License
  15. Creator

Introduction

This project is a demonstration of building an e-commerce application using the MERN stack, which consists of MongoDB (database), Express.js (server), React.js (frontend), and Node.js (runtime environment). The application allows users to browse products, add them to a shopping cart, proceed to checkout, and simulate the order processing. It includes basic validations for user inputs and simulates the checkout process on the backend.

Live Deployment

The application is deployed live on Vercel. You can access it at the following URL: Fusion Electronics.

The backend server is deployed on Render and can be accessed at the following URL: Fusion Electronics API.

Please note that the backend server may take a few seconds to wake up if it has been inactive for a while.

User Interface

Home Page

Fusion Electronics Homepage

Full Product List

Fusion Electronics Products List

Search Results

Fusion Electronics Search Results

Product Details Page

Fusion Electronics Product Details Page

Cart Page

Fusion Electronics Cart Page

Checkout Page

Fusion Electronics Checkout Page

Login Page

Fusion Electronics Login Page

Register Page

Fusion Electronics Register Page

Forgot Password Page

Fusion Electronics Forgot Password Page

Reset Password Page

Fusion Electronics Reset Password Page

Order Confirmation

Fusion Electronics Order Success Page

Features

  • Product Management:

    • View a list of products.
    • View detailed product information.
    • Add products to the shopping cart.

  • Shopping Cart:

    • View items in the shopping cart.
    • Remove items from the cart.
    • Calculate total amount of items in the cart.

  • Checkout Process:

    • Enter billing, shipping, and payment information.
    • Simulate the order creation process on the backend.
    • Receive confirmation of order success.

Technologies Used

  • Frontend:

    • React.js
    • Material-UI for styling
    • Axios for API requests
    • react-credit-cards-2 for credit card visualization
    • react-router-dom for routing
    • react-hook-form for form validation
    • react-toastify for toast notifications
    • Jest and React Testing Library for testing

  • Backend:

    • Node.js
    • Express.js
    • MongoDB (with Mongoose ODM)
    • Axios for external API requests
    • JsonWebToken for user authentication
    • Bcrypt for password hashing
    • Dotenv for environment variables
    • Cors for cross-origin resource sharing
    • Swagger for API documentation
    • Nodemon for server hot-reloading
    • Middleware: JWT for securing API endpoints

  • Development Tools:

    • Jetbrains WebStorm (IDE)
    • Postman (for API testing)
    • Git (version control)
    • npm (package manager)

Project Structure

The project is organized into two main "stacks": The backend is in the backend directory that hosts all product & order data and the frontend is in the root directory. Here is an overview of the project structure:

fullstack-ecommerce/
├── backend/                       # Node.js server files
│   ├── config/                    # Configuration files
│   │   └── db.js                  # Database connection
│   ├── models/                    # Mongoose models
│   │   └── product.js             # Product schema
│   ├── routes/                    # Route handlers
│   │   ├── products.js            # Product routes
│   │   ├── search.js              # Search routes
│   │   └── checkout.js            # Checkout routes
│   ├── seed/                      # Database seed data
│   │   └── products.js            # Product seed data
│   ├── .env                       # Environment variables
│   └── index.js                   # Server entry point
├── public/                        # Frontend public assets
│   ├── index.html                 # HTML template
│   ├── manifest.json              # Web app manifest
│   └── favicon.ico                # Favicon
├── src/                           # React.js frontend files
│   ├── components/                # Reusable components
│   │   ├── CheckoutForm.jsx       # Checkout form component
│   │   ├── ProductCard.jsx        # Product card component
│   │   ├── NavigationBar.jsx      # Navigation bar component
│   │   ├── OrderConfirmation.jsx  # Order confirmation component
│   │   ├── ProductListing.jsx     # Product listing component
│   │   ├── SearchResults.jsx      # Search results component
│   │   └── ShoppingCart.jsx       # Shopping cart component
│   ├── dev/                       # Development utilities
│   │   ├── index.js               # Development entry point
│   │   ├── palette.jsx            # Color palette
│   │   ├── preview.jsx            # Component preview
│   │   └── useInitials.js         # Initials hook
│   ├── pages/                     # Page components
│   │   ├── Cart.jsx               # Cart page component
│   │   ├── Checkout.jsx           # Checkout page component
│   │   ├── Home.jsx               # Home page component
│   │   ├── ProductDetails.jsx     # Product details page component
│   │   ├── OrderSuccess.jsx       # Order success page component
│   │   ├── ProductDetails.jsx     # Product details page component
│   │   └── Shop.jsx               # Shop page component
│   ├── App.jsx                    # Main application component
│   ├── App.css                    # Main application styles
│   └── index.js                   # React entry point
├── build/                         # Frontend production build files
├── tests/                         # Test files
├── .gitignore                     # Git ignore file
├── package.json                   # NPM package file
├── jsconfig.json                  # JS config file
└── setupProxy.js                  # Proxy configuration

Getting Started

Prerequisites

Before running this project, ensure you have the following installed:

  • Node.js (with npm)
  • MongoDB (with either local or remote instance)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/hoangsonww/MERN-Stack-Ecommerce-App.git
cd MERN-Stack-Ecommerce-App  # Fix the path if necessary

  2. Install project dependencies:

    # Install server (backend) dependencies
cd backend
npm install

# Install client (frontend) dependencies
cd ..
npm install

  3. Set up the backend:

    • Create a .env file in the backend/ directory and add the following environment variable (replace the URI with your MongoDB connection string):

      MONGO_URI=mongodb://localhost:27017/Ecommerce-Products
JWT_SECRET=your_secret_key

      For your information, I am using MongoDB Atlas for this project. You can create a free account and get your connection string from there if you want to deploy the application to the cloud.

    • Ensure that your MongoDB server is running. If you're using Mac, you can start the MongoDB server with the following command:

    brew services start mongodb-community

    • Seed the database with sample data:

      cd backend/seed
node productSeeds.js dev

    • Run the backend server: (first cd into the backend directory)

      cd ..
npm start

  4. Set up the frontend:

    • First, cd into the root directory if you are not already there: 
      cd ..
      Or 
      cd fullstack-ecommerce
    • Start the frontend development server: 
      npm start
    • Note: The frontend server will run on http://localhost:3000 by default. If you encounter any errors when starting related to the react-credit-cards-2 package, it is OK to just ignore them as the application will still run correctly.

Running the Application

  • Open your browser and navigate to http://localhost:3000 to view the application.

Testing the APIs

  • Simply open your browser and navigate to http://localhost:5000/api/products to view the list of products.
  • You can also change the sample data by navigating to backend/seed/productSeeds.js and modifying the data there.

Swagger API Documentation

  • The backend server includes Swagger API documentation that can be accessed at http://localhost:5000/api-docs.
  • Before accessing the above URL, ensure that the backend server is running.
  • The Swagger UI provides a detailed overview of the API endpoints, request/response schemas, and example requests.
  • If you have everything set up correctly, you should see the Swagger UI documentation page:

The MovieVerse App Interface

Deployment

To deploy the application:

  • Configure deployment settings for both frontend (React) and backend (Node.js) according to your chosen hosting provider (e.g., AWS, Heroku, Netlify).

Containerization

This project can be containerized using Docker. First, ensure that Docker Desktop is running on your system. Then, to create a Docker image, run the following command:

docker compose up --build

This command will create a Docker image for the frontend and backend, and run the application in a containerized environment.

Contributing

Contributions to this project are welcome! Here are some ways you can contribute:

  • Report bugs and request features by opening issues.
  • Implement new features or enhancements and submit pull requests.
  • Improve documentation and README files.

License

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

Creator

Thank you for exploring Fusion Electronics - a MERN Stack E-commerce Application! If you have any questions or feedback, feel free to reach out or open an issue.

Happy coding! 🚀