Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kartikk-26/e-commerce-project
It is a user-friendly E-Commerce Platform that offers seamless product management, secure checkout, and robust admin controls for an efficient shopping experience.
https://github.com/kartikk-26/e-commerce-project
expressjs javascript json-server mongodb mongoose nodejs reactjs tailwindcss
Last synced: 17 days ago
JSON representation
It is a user-friendly E-Commerce Platform that offers seamless product management, secure checkout, and robust admin controls for an efficient shopping experience.
- Host: GitHub
- URL: https://github.com/kartikk-26/e-commerce-project
- Owner: Kartikk-26
- Created: 2024-09-16T09:20:08.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-08T09:46:33.000Z (about 1 month ago)
- Last Synced: 2024-10-10T14:24:54.767Z (about 1 month ago)
- Topics: expressjs, javascript, json-server, mongodb, mongoose, nodejs, reactjs, tailwindcss
- Language: JavaScript
- Homepage:
- Size: 33.1 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# 💡 WebifyMart
Welcome to **WebifyMart**! 🛒🚀
**WebifyMart** is a comprehensive E-commerce platform designed to provide a smooth and efficient shopping experience.
It offers key features such as product browsing, shopping cart management, and a secure checkout process.
## 📑 Table of Contents
- [Overview](#overview)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Get in Touch](#get-in-touch)
## 📦 Overview
**WebifyMart** simulates a fully operational online store where users can :
- Browse and search for products with detailed descriptions.
- Add, remove, and manage items in their shopping cart.
- Proceed through a secure checkout process.
- Admins can manage inventory, product listings, and orders through a dedicated admin panel.
## 🛠 Tech Stack
The application is built using the following technologies :
- **Frontend**: ReactJS, Tailwind CSS, Bootstrap
- **Backend**: Node.js, Express.js
- **Database**: MongoDB
- **Authentication**: JWT (JSON Web Tokens)
- **Payment Gateway**: Stripe/PayPal integration
## 🎯 Key Features
- **User Authentication** : Secure JWT-based authentication for user registration and login.
- **Product Listings** : Dynamic catalog with filtering and search functionalities.
- **Shopping Cart** : Manage product quantities, add or remove items.
- **Checkout Process** : Integrated payment options for secure transactions.
- **Admin Dashboard** : Comprehensive interface for managing products, categories, and orders.
- **Responsive Design** : Optimized for various devices using Tailwind CSS and Bootstrap.
Here's the updated **Installation** section with the cloning step added as the first point:
---
## 🔐 Installation
To set up **WebifyMart** locally, follow these steps for both the frontend and backend:
### 📂 Repository Clone Instructions :
1. **Clone the repository**:
```bash
git clone https://github.com/Kartikk-26/E-Commerce-Project.git
```
### 📂 Backend Setup :
2. **Navigate to the backend directory** :
```bash
cd Backend
```
3. **Initialize and install backend dependencies** :
```bash
npm init -y
npm install
```
4. **Configure environment variables** :
Create a `.env` file in the `Backend` directory and add:
```env
MONGO_URI = your_mongodb_uri
JWT_SECRET = your_jwt_secret
STRIPE_API_KEY = your_stripe_key
CLIENT_ID = your_client_id
CLIENT_SECRET = your_client_secret
CALLBACK_URL = your_callback_url
```
5. **Start the backend server** :
```bash
npm start
```
### 📁 Frontend Setup :
6. **Navigate to the frontend directory** :
```bash
cd Frontend
```
7. **Initialize and install frontend dependencies** :
```bash
npm init -y
npm install
```
8. **Start the frontend server** :
```bash
npm run dev
```
---
## 🛒 Usage
- **Users** : Register, log in, browse products, manage cart, and complete purchases.
- **Admins** : Access the dashboard to manage product inventory and orders.
## 🧑💻 Contributing
We encourage contributions to enhance **WebifyMart**. To contribute:
- **Fork the repository**
- **Create a new branch**:
```bash
git checkout -b feature-branch
```
- **Commit your changes**:
```bash
git commit -m "Add new feature"
```
- **Push to your branch**:
```bash
git push origin feature-branch
```
- **Submit a pull request** for review.
## 💬 Get in Touch
Stay connected on [LinkedIn](https://www.linkedin.com/in/-kartikjain/) and [GitHub](https://github.com/Kartikk-26) to explore more of my projects and follow my progress as I continue my learning journey.
Let’s collaborate and create impactful web applications together. Feel free to reach out if you have any ideas or opportunities to discuss.
---