E-Commerce Platform DataBase Project

Single Vendor E-Commerce Platform

Description

This project is a full-stack implementation of a single vendor e-commerce platform for a local chain retailer. The platform focuses on consumer electronics and toys in its initial phase, supporting detailed product variants, inventory management, and a comprehensive reporting system for monitoring and analytics.

• Motivation: To help a local retailer remain competitive by establishing a robust online presence.
• Why: The retailer needed to reach the technology side to compete with larger e-commerce platforms.
• Problem Solved: The platform manages product inventory, supports online purchases, and generates detailed sales and delivery reports.
• What We Learned: How to design and implement a comprehensive e-commerce system, manage database relationships and transactions, and create a seamless user experience.

Table of Contents

• Installation
• Usage
• Credits
• License
• Badges
• Features
• How to Contribute

Installation

Follow these steps to set up the development environment for the project:

1. Clone the repository:

   git clone https://github.com/ThisaraWeerakoon/ECommerce_Platform_DataBase_Project

2. Navigate to the project directory:

   cd ECommerce_Platform_DataBase_Project

3. Install the required dependencies for the backend:

   cd server
   npm install

4. Install the required dependencies for the frontend:

   cd client
   npm install

5. Set up the MySQL database:
   • Create a new database.
   • Import the provided SQL schema to set up the tables and initial data.
   • database.sql
6. Configure environment variables:
   • Create a .env file in the backend directory and add your database credentials.
7. Start the backend server:

   cd server
   node index.js

8. Start the frontend server:

   cd client
   npm start

Usage

To use the platform, follow these steps:

1. Register an account or log in as a guest.
2. Browse through the product catalog and select items to add to your cart.
3. View your cart and proceed to checkout.
4. Enter delivery and payment details to complete the purchase.
5. Access the admin panel for detailed sales and inventory reports.

My.Movie.2.mp4

Doucmentation

You can access the software requirement specification SRS Document.pdf and Entity Relationship Diagram ER Diagram.pdf

Credits

We used several third-party assets and tutorials, including:

• React Documentation
• Node.js Documentation
• MySQL Documentation

License

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

Badges

Features

• User registration and login
• Product catalog with variants
• Shopping cart and checkout system
• Inventory management
• Comprehensive reporting system
• Delivery estimation module

How to Contribute

We welcome contributions from the community! If you are interested in contributing, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix:

   git checkout -b feature-or-bugfix-name

3. Commit your changes:

   git commit -m "Description of the feature or bug fix"

4. Push to the branch:

   git push origin feature-or-bugfix-name

5. Open a pull request and provide a detailed description of your changes.