README

Package Overview

The BrightWeb E-Commerce package is a comprehensive e-commerce solution built with Laravel, Livewire, HTML, CSS, and JavaScript. This package offers a robust frontend and backend system to efficiently manage and sell products online.

With features tailored for modern e-commerce needs, it simplifies the process of building and maintaining an online store, allowing developers to focus on enhancing user experience and business growth.

Features:

Automatic installation of Livewire.
Simple table migration with php artisan migrate.
Admin dashboard for managing categories, products, and orders.
Support for product variations, pricing, discounts, and inventory management.
Configurable payment gateways including PayPal, Paystack, and Pay on Delivery.
Email notifications for order confirmations (both user and admin).
Automatic cleanup of delivered orders after 7-9 days.
Fully customizable frontend and backend settings.

Installation Instructions

Step 1: Install the Package

To install the package, use Composer:

composer require brightweb/ecommerce

Step 2: Migrate the Database

Run the following command to create the necessary tables:

php artisan migrate

Step 3: Start the Project

Start your Laravel development server with php artisan serve:

php artisan serve

Remember to comment your defalut laravel home page route for your site to use the packge home directory, to do this, navigate into routes/web.php

// Route::get('/', function () {
//     return view('welcome');
// });

Step 4: Promote an Admin User

Manually promote user to admin by editing the users table in the database: after registration

Locate the user’s record.
Update the role field to admin.

After logging in as an admin, the Admin Dashboard will be accessible via the navigation bar.

Features and Functionalities

Product Management

Admins can:

Add product categories.
Add products with details such as:
- Variations (e.g., size, color).
- produts gallery.
- Purchase price.
- Selling price.
- Quantity.
- Discount.
- coupon code.
- Add background image optional

Order Management

Users receive an email confirmation upon placing an order.
Admins receive an email notification with order details.
Admins can process orders via the Admin Dashboard.
Users can track their orders in their dashboard.
Delivered orders are automatically deleted from the system after 7-9 days.

Payment Gateway Configuration

The package supports multiple payment methods:

PayPal
Paystack
Pay on Delivery

Other payment methods like Stripe and Razorpay are placeholders for future implementation.

Configuration Options

Run the following command to publish the configuration file:

php artisan vendor:publish --tag=brightwebconfig

The configuration file will be located at config/brightwebconfig.php.

Payment Settings

'mypayment_options' => [
    'enable_stripe' => false, // Stripe not yet implemented
    'enable_razorpay' => false, // Razorpay not yet implemented
    'enable_paypal' => true, // To disable PayPal, set it to false
    'enable_paystack' => true, // To disable Paystack, set it to false
    'enable_pay_on_delivery' => true, // To disable Pay on Delivery, set it to false
],

Currency Settings

'currency' => [
    'site_Currency' => '$',// here you can add your currency 
],

Frontend Category Settings

'frontend_category_settings' => [
    'show_top_categories' => true, // Show top categories, to disable it set it to false
    'show_sidebar_category' => true, // Show sidebar categories, to disable it set it to false
],

Frontend Navigation Settings

To setup the colors of your navigation

'frontend_navigation_settings' => [
    'navigation_bg_color' => 'black',
    'navigation_text_color' => 'white',
],

Product slider or background image Customizer

Please select your **preference** or disable both options by setting them to false.

 If you choose "show_background_image," ensure you upload a suitable image via the admin dashboard.
 
Customize the image to match your design requirements.

'slider_display_option'=>[
        "show_slider"=>true,# To disabled, set it to false
        "show_background_image"=>false,# To enabled, set it to true
    ],

Frontend Site Settings

'frontend_site_settings' => [
    'site_bg_color' => '#ffffff',
    'site_primary_color' => 'blue',
    'site_button_color' => 'white',
    'site_text_color' => 'gray',
],

Admin Site Settings

'admin_site_settings' => [
    'site_bg_color' => '#ffffff',
    'site_primary_color' => 'blue',
    'site_button_color' => 'white',
    'gradient1' => 'rgb(131,58,180)',
    'gradient2' => 'linear-gradient(90deg, rgba(131,58,180,1) 0%, rgba(253,29,29,1) 50%, rgba(252,176,69,1) 100%)',
    'counter_color' => 'white',
],

Payment Gateway Setup

PayPal

Add the following to your .env file:

PAYPAL_CLIENT_ID="your_client_id"
PAYPAL_CLIENT_SECRET="your_client_secret"

Paystack

Add the following to your .env file:

PAYSTACK_SECRET_KEY="your_secret_key"
PAYSTACK_PUBLIC_KEY="your_public_key"

Run the code below to clear all cacch

php artisan config:clear
php artisan cache:clear

Enable or Disable Translator

  "translator"=>[
        "enable_google_translate"=>true,#Enable or Disable google translate
    ],

Notes

For testing purposes, an admin user cannot purchase items.
After registretion, To test as a user, do not promote the test email to admin.
Email notifications will be sent for order confirmations.
Regularly update your .env file with valid keys for payment gateways.

Email Configuration:

Set up email services in the .env file. For Gmail, you can use the following configuration for testing:

MAIL_MAILER=smtp
MAIL_HOST=smtp.gmail.com
MAIL_PORT=587
MAIL_USERNAME=youremail@domain.com
MAIL_PASSWORD="password"
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS=youremail@domain.com
MAIL_FROM_NAME="${APP_NAME}"

The site will send an email to an admin using your MAIL_FROM_ADDRESS on .env

SEO Features

The package includes SEO-friendly features to optimize your site for search engines. As an admin, you can configure:

Site Name SEO Meta Tags (e.g., meta description, meta keywords) Social Media Previews (e.g., Twitter Card settings) Admin SEO Configuration Example: Twitter Title Meta Description Keywords These settings are available through the Admin Dashboard and can be adjusted in real-time.

Troubleshooting

Issue: Admin Access Not Visible Ensure you’ve set the correct role to admin in the database for the user account. Issue: Payments Not Processing Double-check the credentials in your .env file for PayPal and Paystack.

License

This package is open-sourced software licensed under the MIT license.

Contributing

We welcome contributions to enhance this package. Please contact us at chikanwazuo@gmail.com

Thank you for choosing BrightWeb E-Commerce! If you have any questions or need support, please feel free to open an issue on GitHub.

Conclusion

The BrightWeb E-Commerce Package is an excellent tool for building scalable e-commerce sites with powerful admin and user features. Customize the frontend and backend settings to suit your needs, and easily manage orders, products, and payments.

Explore the Admin Dashboard for further customization and enhancements, and enjoy building your e-commerce site!

Support

For support, please send us an email at chikanwazuo@gmail.com

brightweb / ecommerce

Maintainers

Details