socialrabbit/bunny

The Ultimate Laravel Website Scaffolding Package

Maintainers

Details

github.com/socialrabbit/bunny

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 0

Forks: 0

Open Issues: 0

pkg:composer/socialrabbit/bunny

2.1 2025-12-08 18:03 UTC

Requires

Requires (Dev)

MIT 4fa221b90a6a509c1885271884c89c27fff13c0e

  • Kisal Nelaka <iamsocialrabbit.woop@gmail.com>

This package is auto-updated.

Last update: 2025-12-08 18:04:56 UTC

README

Latest Stable Version License

Bunny is a powerful Laravel package that provides instant website scaffolding for multiple website types. Get your project up and running in minutes with pre-built components, authentication, and modern UI.

Features

Website Types

Bunny supports multiple website types out of the box:

  • Portfolio: Showcase your work with a beautiful portfolio site
  • E-commerce: Full-featured online store with cart and checkout
  • Educational: Learning management system with courses and students
  • Healthcare: Patient management and appointment booking
  • Hospitality: Hotel/restaurant booking and management
  • Real Estate: Property listings and management

Version Comparison

Free Version

  • Portfolio Website Type
  • Basic Features
  • Community Support

Paid Version (Premium)

  • All Website Types (Ecommerce, Educational, Healthcare, etc.)
  • Advanced Features (Analytics, Marketing, SEO Pro)
  • Priority Support
  • 14-Day Free Trial (Full Access)

Core Features

  • Modern UI with responsive design
  • SEO optimization
  • Analytics integration
  • Media management
  • User authentication
  • Role-based permissions
  • Multi-language support
  • Theme customization
  • API integration
  • Performance optimization

Requirements

  • PHP >= 8.1
  • Laravel >= 10.0
  • Composer
  • MySQL 5.7+ / PostgreSQL 9.6+ / SQLite 3.8+

Installation

Quick Install

composer require socialrabbit/bunny
php artisan bunny:install

What Happens During Installation

  1. Email Address: You'll be asked to enter your email (validated)
  2. Unique Secret Generated: The system generates a unique 64-character secret for your installation
  3. Secret Displayed: Both your email and secret are displayed prominently:
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
🔑 YOUR UNIQUE LICENSE SECRET (IMPORTANT!)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  Email:  your@email.com
  Secret: a1b2c3d4e5f6...

⚠️  IMPORTANT: Save this information!
   To obtain a license key, send BOTH your email and secret to the package maintainer.
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
  1. Trial Starts: 14-day free trial begins automatically with full access to all features

After Installation

Once you receive your license key from the maintainer:

php artisan bunny:activate

Or provide the key directly:

php artisan bunny:activate your-license-key-here

Version Behavior

  • During Trial (14 days): Full access to all features
  • After Trial (no license): Reverts to free version (Portfolio only)
  • With License: Full access to all features permanently

Important: Each installation has a unique secret. To get a license key, you must provide BOTH your email and the secret shown during installation to the package maintainer.

For detailed installation instructions, see INSTALLATION.md.

Quick Start

Create Your First Website

# Create a portfolio website (Free version)
php artisan bunny:create portfolio

# Create an e-commerce website (Paid version)
php artisan bunny:create ecommerce

Available Website Types

php artisan bunny:create {type}

Where {type} can be:

  • portfolio (Free)
  • ecommerce (Paid)
  • educational (Paid)
  • healthcare (Paid)
  • hospitality (Paid)
  • real_estate (Paid)

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=bunny-config

Edit config/bunny.php to customize your setup:

return [
    'license' => env('BUNNY_LICENSE_KEY', 'free'),
    'license_secret' => env('BUNNY_LICENSE_SECRET'),
    'default_type' => 'portfolio',
    // ... more options
];

Environment Variables

These are automatically added to your .env file during installation:

BUNNY_USER_EMAIL=your@email.com              # Your email (entered during install)
BUNNY_LICENSE_SECRET=auto-generated-secret   # Unique 64-char hex (auto-generated)
BUNNY_LICENSE_KEY=                           # Your license key (optional)
BUNNY_SITE_TYPE=portfolio                    # Website type (set during install)

Note: BUNNY_LICENSE_SECRET is automatically generated during installation. You don't need to set it manually.

Docker & Laravel Sail

For Docker and Laravel Sail setup, see DOCKER_GUIDE.md.

Quick start with Sail:

curl -s https://laravel.build/my-bunny-app | bash
cd my-bunny-app
./vendor/bin/sail up -d
./vendor/bin/sail composer require socialrabbit/bunny
./vendor/bin/sail artisan bunny:install

License

Obtaining a License

During installation (php artisan bunny:install), the system generates a unique secret for your installation and displays it along with your email.

To obtain a license key:

  1. Save your credentials shown during installation:

    • Email address
    • Unique secret (64-character hex string)

  2. Contact the package maintainer with both:

    • Your email
    • Your unique secret

  3. Receive your license key generated specifically for your installation

  4. Activate using the command:

    php artisan bunny:activate your-license-key-here

    Or run interactively:

    php artisan bunny:activate

Important:

  • Each installation has a unique secret
  • License keys are tied to both email AND secret
  • Keys won't work on different installations

License Verification

The license system verifies:

  • ✅ Email address matches
  • ✅ Unique secret matches
  • ✅ License hasn't expired

For Maintainers: Generating License Keys

This repository includes generate_license.php for generating license keys.

Usage

php generate_license.php <email> <secret> [days]

Arguments:

  • email - User's email address (from their installation)
  • secret - User's unique 64-character hex secret (from their installation)
  • days - Optional: License validity in days (default: 365)

Example:

php generate_license.php user@example.com a1b2c3d4e5f6789... 365

Output:

  • Formatted license key
  • Email template for sending to user
  • Option to save details to file (saved as license_*.txt, ignored by git)

Important:

  • Users will send you their email + secret after installation
  • Each installation has a unique secret
  • License keys only work for the specific email + secret combination

Documentation

Customization

Publish Views

php artisan vendor:publish --tag=bunny-views

Views will be published to resources/views/vendor/bunny.

Publish Assets

php artisan vendor:publish --tag=bunny-assets

Assets will be published to public/vendor/bunny.

Publish Migrations

php artisan vendor:publish --tag=bunny-migrations

Support

Contributing

Please see CONTRIBUTING.md for details.

Security

If you discover any security-related issues, please email iamsocialrabbit@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Powered by SocialRabbit