📦 E_commerce_29

🌟 Single Vendor E-Commerce Platform

Project Description

Shopzy is a local chain retailer in Texas aiming to enhance its online presence to compete with major players like Amazon. The project involves designing and developing a robust e-commerce platform that will initially focus on consumer electronics and toys. The company maintains its own stock in several warehouses and has a subsidiary courier service for deliveries.

🚀 Features

• Product Management: Supports multiple product variants, categories, and custom attributes.
• Inventory Management: Tracks product availability and updates inventory upon order completion.
• User Management: Allows customers to register, browse as guests, add products to the cart, and complete purchases.
• Order Management: Manages customer details, delivery methods, payment methods, and ensures consistency in transactions.
• Delivery Module: Provides delivery time estimates based on stock availability and delivery location.

📦 Delivery Module Rules

• Main City Delivery (e.g., Colombo):
  • In stock: 5 days
  • Out of stock: 8 days
• Non-Main City Delivery (e.g., Negombo):
  • In stock: 7 days
  • Out of stock: 10 days
• Delivery estimates will be shown during checkout.

🗄️ Database Design

• Entities and Relationships: The database will encapsulate all entities and relationships described in the project requirements.
• Procedures, Functions, and Triggers: Used to ensure ACID properties and maintain consistency.
• Keys and Indexing: Foreign keys and primary keys will be set to maintain consistency, and indexing will be done as necessary.
• Data Population: The database will be populated with at least 40 products, including variants, and at least 10 different categories.

🛠️ Getting Started

1. Clone the Repository:

   git clone https://github.com/GamiXChanuka/E_commerce_29.git

2. Install Dependencies:

   npm install

3. Run the Application:

   npm start

💻 Technologies Used

Explore the powerful technologies that power this e-commerce platform:

Technology	Usage Percentage
TypeScript	90.7%
JavaScript	7.2%
CSS	2.1%

🤝 Contributing

Contributions are welcome! To ensure a smooth collaboration, please follow these guidelines:

1. Fork the Repository

   • Click on the Fork button in the top right corner of the repository page to create your copy of the repository.

2. Clone Your Fork

   • Clone your forked repository to your local machine:

     git clone https://github.com/your-username/E_commerce_29.git

   • Replace your-username with your GitHub username.

3. Create a New Branch

   • Navigate to your local repository:

     cd E_commerce_29

   • Create a new branch for your feature or bug fix:

     git checkout -b feature-branch

4. Make Changes

   • Implement your feature or fix the bug. Make sure to test your changes thoroughly.

5. Commit Your Changes

   • Stage your changes:

     git add .

   • Commit your changes with a descriptive message:

     git commit -m 'Add feature or fix bug'

6. Push to Your Branch

   • Push your changes to your forked repository:

     git push origin feature-branch

7. Open a Pull Request

   • Go to the original repository (not your fork) and click on the Pull Requests tab.
   • Click on New Pull Request and select your branch.
   • Provide a clear description of your changes and submit the pull request.

📋 Code of Conduct

Please adhere to the project's Code of Conduct to maintain a welcoming and inclusive community.

📝 Additional Notes

• Be respectful and constructive in your feedback.
• For large changes, it might be helpful to open an issue first to discuss your ideas with the maintainers.

📜 License

This project is licensed under the MIT License.

✨ Authors

• GamiXChanuka
• NaveenSandaruwan
• InduwaraRathnayake
• chaminduSathsara
• code-GDC

For more details, visit the repository here.