livecoat — Laravel Starter Template

SHA-256: 56d94ef1fbb13bd40aa9e5822c7e689d021b1c058ee6ac6596c86a7257876e2b

2026-10-03T07:44:04.035Z

# Livecoat Starter Kit

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Laravel](https://img.shields.io/badge/Laravel-12+-FF2D20.svg)](https://laravel.com)
[![Livewire](https://img.shields.io/badge/Livewire-3+-FB70A5.svg)](https://laravel-livewire.com)
[![BasecoatUI](https://img.shields.io/badge/BasecoatUI-Modern-6366F1.svg)](https://basecoatui.com)

⚡ **A powerful Laravel starter kit combining Livewire with BasecoatUI.com for rapid application development**

Livecoat is a comprehensive starter template designed for backend developers who want to kickstart their Laravel applications with modern UI components and essential features built-in. No more wasting time on repetitive setup tasks - focus on building your unique features from day one.

## 🚀 Features

### 🔐 Authentication & Security
- **TOTP Authenticator** - Built-in two-factor authentication using pragmRX
- **Google reCAPTCHA v2** - Protect your logins from bots
- **Role-based Permissions** - Integrated Spatie role and permissions system

### 🎨 User Interface & Experience
- **BasecoatUI Components** - Beautiful, modern UI components (shadcn-inspired)
- **Dark/Light Mode** - Built-in theme switching with system preference detection
- **Responsive Design** - Mobile-first approach with Tailwind CSS
- **Filament 4 Support** - Component-based integration

### ⚙️ Developer Experience
- **Customizable App Settings** - Easily change app name, version, icon, and logo
- **Livewire 3+** - Reactive UI components without writing JavaScript
- **Laravel 12+** - Latest Laravel features and best practices
- **Component Architecture** - Reusable, maintainable code structure

### 🛠️ Built-in Tools
- **User Management** - Complete user CRUD operations
- **Role Management** - Flexible role and permission system
- **Profile Management** - User profile editing with avatar support
- **Settings Panel** - Application configuration interface
- **Dynamic Menu System** - Hierarchical navigation with permission-based access control

### 🎯 Built-in Menu Structure

The starter kit includes a comprehensive menu system with the following structure:

```php
$menu = [
    [
        'group' => __('General'),
        'items' => [
            [
                'title' => __('Dashboard'),
                'icon' => 'lucide-home',
                'route' => route('app.dashboard'),
                'active' => request()->routeIs('app.dashboard'),
                'permission' => 'View Dashboard'
            ],
            [
                'title' => __('User Access'),
                'icon' => 'lucide-user',
                'route' => route('app.user'),
                'active' => request()->routeIs('app.user'),
                'permission' => 'View Users'
            ],
            [
                'title' => __('Settings'),
                'icon' => 'lucide-settings',
                'active' => request()->routeIs('app.settings.*'),
                'sub' => [
                    [
                        'title' => __('Permission Groups'),
                        'route' => route('app.settings.permission-group'),
                        'active' => request()->routeIs('app.settings.permission-group'),
                        'permission' => 'View Permission Groups'
                    ],
                    [
                        'title' => __('Permissions'),
                        'route' => route('app.settings.permission'),
                        'active' => request()->routeIs('app.settings.permission'),
                        'permission' => 'View Permissions'
                    ],
                    [
                        'title' => __('Roles'),
                        'route' => route('app.settings.role'),
                        'active' => request()->routeIs('app.settings.role'),
                        'permission' => 'View Roles'
                    ],
                    [
                        'title' => __('System Settings'),
                        'route' => route('app.settings.system-setting'),
                        'active' => request()->routeIs('app.settings.system-setting'),
                        'permission' => 'View System Settings'
                    ],
                ],
            ],
        ],
    ],
];
```

**Menu Features:**
- **Permission-based visibility** - Items only show if user has required permissions
- **Active state detection** - Automatic highlighting of current page
- **Hierarchical structure** - Support for nested submenus
- **Icon integration** - Uses Lucide icons via blade-lucide-icons package
- **Internationalization ready** - All text supports Laravel's translation system

## 📋 Requirements

- PHP 8.2+
- Composer
- Node.js & NPM
- MySQL or PostgreSQL
- Redis (Optional) (recommended for caching)

## 🛠️ Installation

1. **Clone the repository**
   ```bash
   git clone https://github.com/developerabdan/livecoat.git
   cd livecoat
   ```

2. **Install dependencies**
   ```bash
   composer install
   npm install
   npm run build
   ```

3. **Environment setup**
   ```bash
   cp .env.example .env
   php artisan key:generate
   ```

4. **Configure your database**
   ```bash
   # Edit .env file with your database credentials
   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=your_database
   DB_USERNAME=your_username
   DB_PASSWORD=your_password
   ```

5. **Run migrations and seed**
   ```bash
   php artisan migrate --seed
   ```

6. **Start the development server**
   ```bash
   php artisan serve
   npm run dev
   ```

7. **Visit your application**
   ```
   http://localhost:8000
   ```

## ⚙️ Configuration

### Role & Permissions

The starter kit comes with a pre-configured role system:

- **Super Admin**: Full system access

Add custom roles and permissions through the admin panel or programmatically:

```php
// Create a new role
$role = Role::create(['name' => 'moderator']);

// Assign permissions
$role->givePermissionTo(['edit-posts', 'delete-comments']);

```

## 🎯 Usage Examples

### Creating a New Livewire Component

```bash
php artisan make:livewire UserProfile
```

This creates:
- `app/Livewire/UserProfile.php`
- `resources/views/livewire/user-profile.blade.php`

## 🤝 Contributing

We welcome contributions! Here's how you can help:

1. **Fork the repository**
2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)
3. **Commit your changes** (`git commit -m 'Add amazing feature'`)
4. **Push to the branch** (`git push origin feature/amazing-feature`)
5. **Open a Pull Request**

## 📝 Roadmap

- [ ] Fully Reusable Basecoat Components
- [ ] Multi-language support
- [ ] Advanced logging
- [ ] Testing
- [ ] Documentation

## 🙏 Acknowledgments

- **[Laravel](https://laravel.com)** - The PHP framework for web artisans
- **[Livewire](https://laravel-livewire.com)** - Dynamic interfaces without JavaScript
- **[BasecoatUI](https://basecoatui.com)** - Beautiful UI components
- **[Spatie](https://spatie.be)** - Excellent Laravel packages
- **[Google2Fa](https://github.com/antonioribeiro/google2fa)** - TOTP authentication library
- **[Filament](https://filamentphp.com)** - Elegant admin panels
- **[Blade Lucide Icons](https://github.com/mallardduck/blade-lucide-icons)** - Lucide icon components for Blade

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ⭐ Show Your Support

If you find this starter kit helpful, please consider:

- **⭐ Starring this repository** - It helps more developers discover it
- **🐛 Reporting issues** - Help us improve by reporting bugs
- **💡 Suggesting features** - Share your ideas for improvements
- **📢 Sharing with others** - Spread the word about Livecoat

---

**Made with ❤️ for the Laravel community**

Built by backend developers, for backend developers. Stop wasting time on boilerplate and start building amazing applications today.