Petal Hut

Table of Contents

• Introduction
• Features
• Technologies Used
• Installation
• Usage
• Contributing
• License
• Contact

Introduction

Petal Hut is a plant selling website designed to connect plant enthusiasts with sellers. The platform allows users to create accounts, browse and purchase plants, and make payments securely through Stripe. Sellers can manage their products and orders, while admins oversee the platform's operations, ensuring quality and reliability.

Features

• User Roles: Admin, Seller, and User (Buyer)
• Secure Authentication: User registration and login via Laravel Breeze
• Product Management: Sellers can add, update, and manage products
• Order Management: Sellers can process and update order statuses
• Dashboard: Interactive dashboards for admins and sellers with charts and data visualization
• Payment Integration: Secure credit card payments via Stripe
• PDF Generation: Export data as PDFs using Laravel DOMPDF
• Email Notifications: Automated emails for account and order updates
• Responsive Design: Styled using Tailwind CSS for a seamless user experience

Technologies Used

• Backend: Laravel
• Frontend: Tailwind CSS, jQuery
• Payment Gateway: Stripe
• Charts: Laravel Charts
• PDF Generation: Laravel DOMPDF
• Database: MySQL
• Authentication: Laravel Breeze

Installation

1. Clone the repository:

   git clone https://github.com/kavindu-udara/petal-store.git
   cd petal-store

2. Install dependencies:

   composer install
   npm install

3. Set up environment variables: Copy the .env.example file to .env and update the necessary environment variables, especially database and Stripe configurations.

4. Generate application key:

   php artisan key:generate

5. Run database migrations and seeders:

   php artisan migrate --seed

6. Build assets:

   npm run dev

7. Start the development server:

   php artisan serve

Usage

• Admin:

  • Approve or reject seller accounts and products
  • Manage users, orders, and site settings
  • View data and metrics on the admin dashboard

• Seller:

  • Create and manage account
  • Add, update, and manage products
  • Process and manage orders
  • View metrics on the seller dashboard

• User (Buyer):

  • Create and manage account
  • Browse and purchase products
  • Update profile and address information

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.

License

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

Contact

For any questions or suggestions, feel free to reach out:

• GitHub: kavindu-udara
• Email: Your Email

---