README

A Laravel and Livewire starter kit featuring ArtisanPack UI components for rapidly building modern, responsive web applications.

Features

Modern Stack: Built with Laravel 12, Livewire 3, Volt, Flux, and Tailwind CSS 4
ArtisanPack UI Components: Pre-built UI components for rapid development
Authentication System: Complete authentication with login, registration, password reset, and email verification
User Settings: Profile, password, and appearance management
Responsive Design: Mobile-first approach with responsive layouts
Dark Mode Support: Built-in light/dark mode with system preference detection
Accessibility: Integrated with ArtisanPack UI accessibility features
Security: Built-in security features and best practices
Modular Structure Option: Optional modular Laravel architecture using nwidart/laravel-modules
Optional Packages: Choose from additional ArtisanPack UI packages during setup (code-style, icons, hooks, media-library, drag-and-drop)

Requirements

PHP 8.2 or higher
Composer
Node.js and NPM

Installation

Create a new project using Composer:

composer create-project laravel/livewire-starter-kit your-project-name

Or clone the repository:

git clone https://github.com/your-username/livewire-starter-kit.git your-project-name
cd your-project-name
composer install

During the installation process, you'll be prompted to:
- Select optional ArtisanPack UI packages (code-style, icons, hooks, media-library)
- Choose optional npm packages (drag-and-drop)
- Decide whether to use a modular Laravel structure
Configure your database in the .env file (automatically created during installation)
Start the development server:

composer dev

This will start the Laravel server, queue worker, logs, and Vite development server concurrently.

For detailed installation instructions, see the Installation Guide.

Documentation

Comprehensive documentation is available in the /docs directory:

Installation - Complete installation guide
Getting Started - Tutorial and first steps
Configuration - Environment and application configuration
Authentication - User authentication system
Components - Livewire, Volt, and ArtisanPack UI components
Modular Structure - Optional modular Laravel architecture
Testing - Testing with Pest PHP
Deployment - Deploy to various platforms
Contributing - Contribution guidelines
Troubleshooting - Common issues and solutions
FAQ - Frequently asked questions

Usage

Development

For local development, use the following command:

composer dev

This will start the Laravel server, queue worker, logs, and Vite development server concurrently.

Building for Production

To build assets for production:

npm run build

Running Tests

composer test

See the Testing documentation for comprehensive testing guides.

Project Structure

The starter kit follows Laravel's standard directory structure with some additions:

app/: Contains the core code of the application
resources/views/components/: Contains ArtisanPack UI components
resources/views/livewire/: Contains Livewire components
resources/css/: Contains CSS files including ArtisanPack UI theme
routes/: Contains route definitions
Modules/: (Optional) Contains modular application structure if enabled

ArtisanPack UI Components

The starter kit includes various ArtisanPack UI components:

Navigation components
Form elements
Buttons and links
Layout components
Toast notifications
Icons
And more

Configuration

Theme Customization

You can customize the theme by modifying the resources/css/artisanpack-ui-theme.css file.

Application Configuration

Standard Laravel configuration files are located in the config/ directory.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Changelog

See CHANGELOG.md for more information on what has changed recently.

artisanpack-ui / livewire-starter-kit

Maintainers

Details