Skip to content

Latest commit

 

History

History
138 lines (95 loc) · 4.07 KB

README.md

File metadata and controls

138 lines (95 loc) · 4.07 KB
Raw

DevCart eCommerce Platform

Live on (https://devcart.onrender.com/)

eCommerce platform built with the MERN stack & Redux.

Home Page Product Page

## Features
  • User Authentication: Secure user authentication for personalized shopping experiences.
  • Product Search: Efficient product search functionality for a smoother user experience.
  • Cart Management: Seamless cart management for a convenient shopping journey.
  • Admin product management, user management, and Admin Order details page.
  • Checkout process (shipping, payment method, etc)
  • Scalability: Built with Docker and Kubernetes to scale effortlessly in a production environment.
  • Database seeder (products & users)

CI/CD Pipeline

The project incorporates a robust CI/CD pipeline with Jenkins, SonarQube, and Trivy for efficient code analysis, quality assurance, and security scans.

CI/CD Pipeline for DevCart

A powerful CI/CD pipeline for DevCart, a MERN e-commerce app, designed for scalability.

Pipeline Steps

  1. Clean Workspace: Ensure a fresh start for each build.

  2. Checkout from Git: Fetch the latest code from the 'docker' branch.

  3. SonarQube Analysis: Perform code analysis for quality assurance.

  4. Quality Gate: Ensure code quality meets defined standards.

  5. Install Frontend/Backend Dependencies: Set up project dependencies.

  6. OWASP & TRIVY Scans: Check for security vulnerabilities in dependencies.

  7. Create .env File: Configure environment variables.

  8. Docker Build & Push: Build Docker images, tag, and push to the registry.

  9. TRIVY Image Scans: Scan Docker images for vulnerabilities.

  10. Deploy to Containers: Deploy the application using Docker Compose.

Usage

Clone the repository, follow the pipeline steps, and launch DevCart effortlessly.

Feel free to contribute and enhance the pipeline for continuous improvement.

Pipeline Kubernetes Dashboard

YouTube Video

Check out the detailed walkthrough of DevCart on YouTube:

DevCart YouTube Walkthrough

Getting Started

Follow these steps to get the project up and running on your local machine:

Clone the repository:

   git clone https://github.com/Ratnesh4193/devcart.git

Navigate to the project directory:

   cd devcart

Install frontend and backend dependencies:

cd frontend && npm install
cd ../backend && npm install

Create a .env file in the project root and configure your environment variables.

touch .env

Run

# Run frontend (:3000) & backend (:5000)
npm run dev

# Run backend only
npm run server

Build & Deploy

# Create frontend prod build
cd frontend
npm run build

Build and run the Docker containers:

docker-compose up -d --build

Access the application at http://localhost:3000.

There is a Heroku postbuild script, so if you push to Heroku, no need to build manually for deployment to Heroku

Seed Database

You can use the following commands to seed the database with some sample users and products as well as destroy all data

# Import data
npm run data:import

# Destroy data
npm run data:destroy

Sample User Logins

[email protected] (Customer)
123456

[email protected] (Customer)
123456

Contributing

Contributions are welcome! Fork the repository, create a branch, commit your changes, and open a pull request. Check out the Contributing Guidelines for more details.