Livewire Starter

A modern Laravel application starter kit with Livewire 3, Bootstrap 5, and Material Icons

---

About

This is a Laravel 11 starter application featuring Livewire 3, Bootstrap 5, and Material Icons. It provides a solid foundation for building modern, interactive web applications with minimal setup.

Built With

• Laravel 11 - The PHP framework for web artisans
• Livewire 3 - Full-stack framework for Laravel
• Bootstrap 5.3 - Powerful, extensible frontend toolkit
• Material Icons - Beautiful, consistent iconography
• Laravel Breeze - Authentication scaffolding
• Pest - Testing framework with a focus on simplicity

Features

• ✅ Pre-configured authentication (login, register, password reset)
• ✅ Bootstrap 5 dashboard layout with sidebar navigation
• ✅ Material Icons integration
• ✅ Prism.js syntax highlighting
• ✅ Vite for modern asset bundling
• ✅ Docker support via Laravel Sail
• ✅ Comprehensive setup and run scripts
• ✅ Test suite with Pest

---

Quick Start

Prerequisites

• PHP 8.2+ (or Docker for Sail)
• Composer
• Node.js 18+ and npm
• Docker (optional, for Laravel Sail)

Installation

1. Clone the repository

   git clone <repository-url>
   cd livewire-starter

2. Run the setup script

   ./setup.sh

   The setup script will:

   • Check system requirements
   • Install Composer dependencies
   • Install NPM dependencies
   • Set up environment configuration
   • Generate application key
   • Run database migrations
   • Seed the database with a test user
   • Build frontend assets

3. Choose your development environment

   • Option 1: Direct PHP (requires local PHP installation)
   • Option 2: Laravel Sail (uses Docker, no local PHP needed)

---

Running the Application

Option 1: Direct PHP

If you have PHP 8.2+ installed locally:

./RUN.sh

This will start the Laravel development server at http://localhost:8008.

Important: You must also run Vite for asset compilation:

npm run dev

Or build for production:

npm run build

Option 2: Laravel Sail (Docker)

If you prefer using Docker:

./run-sail.sh

This will start all Docker containers. The application will be available at http://localhost.

Important: You must also run Vite inside the Sail container:

./vendor/bin/sail npm run dev

---

Default Credentials

After running the setup script, you can log in with:

• Email: test@example.com
• Password: password

---

Development

Running Tests

php artisan test

Or with Sail:

./vendor/bin/sail artisan test

Code Formatting

This project uses Laravel Pint for code formatting:

vendor/bin/pint

Database Migrations

php artisan migrate

Or with Sail:

./vendor/bin/sail artisan migrate

Seeding the Database

php artisan db:seed

Or with Sail:

./vendor/bin/sail artisan db:seed

---

Project Structure

livewire-starter/
├── app/                    # Application core
│   ├── Http/              # Controllers, middleware, requests
│   ├── Livewire/          # Livewire components
│   └── Models/            # Eloquent models
├── resources/
│   ├── views/             # Blade templates
│   │   ├── auth/         # Authentication views
│   │   ├── layouts/      # Layout templates
│   │   └── livewire/     # Livewire component views
│   ├── js/                # JavaScript files
│   └── sass/              # SCSS stylesheets
├── routes/                 # Route definitions
├── tests/                  # Test files
├── public/                 # Public assets
└── setup.sh               # Setup script

---

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects.

Key Features

• Simple, fast routing engine
• Powerful dependency injection container
• Multiple back-ends for session and cache storage
• Expressive, intuitive database ORM
• Database agnostic schema migrations
• Robust background job processing
• Real-time event broadcasting

---

Learning Resources

• Laravel Documentation - Comprehensive framework documentation
• Livewire Documentation - Learn Livewire 3
• Laravel Bootcamp - Guided tutorial for building a Laravel app
• Laracasts - Video tutorials on Laravel and modern PHP

---

Contributing

Thank you for considering contributing to this project! Please feel free to submit issues, fork the repository, and create pull requests.

---

License

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

---

Credits

Created and sponsored by

Check out UltraViolet for a premium Livewire template a bunch of templates!

Huement.com | Blog

Check out huement.com/blog for cool articles, tutorials, and insights about Laravel, Livewire, and modern web development!

---

Made with ❤️ by the team at Huement