README

Start a new PHP project by scaffolding a Laravel, Livewire, and Tailwind CSS. It combines the latest technologies and best practices.

🚀 Features

• User authentication and authorization
• Profile management and customization
• Appearance themes and settings
• Responsive design across all devices
• Modern UI with Tailwind CSS
• Real-time interactions with Livewire Flux
• Secure user authentication flow

🔧 Tooling

• Github Action workflow
  • run tests
  • static analysis
  • code formatting fix
• Eloquent:
  • Unguard
  • Strict mode
  • Automatically eagerLoad relationships
• Pest Testing:
  • Architecture testing
  • LazilyRefreshDatabase
  • HTTP Client: Prevents stray requests
• Pint: Styling with Laravel preset
• Rector: Laravel upgrade rules set
• Middlewares: Collection of useful middlewares
• Deployment script
• Cursor rules

📖 Usage

Scaffold the Laravel app via composer:

composer create-project jewei/laravel-skeleton

Start the development server:

composer dev

Run the test suite:

composer test

Fix code style issues:

composer fix

🛠️ Tall Stack

• Backend: PHP 8.3, Laravel 12
• Frontend: Livewire Flux, Tailwind CSS 4
• Development: Vite, Pint, Rector, PHPStan
• Testing: Pest PHP, Peck

📋 Requirements

• PHP 8.3+
• Composer
• NPM or preferably Bun
• PostgreSQL/SQLite

What's next?

1. Update this file README.md to reflect your new project.
2. Find out more on Laravel's documentation about next step.

🙏 Acknowledgements

• Laravel - The web framework used
• Livewire - Full-stack framework for Laravel
• Tailwind CSS - CSS framework
• Pest PHP - Testing framework
• Peck - Additional testing tools
• All contributors who have helped shape this project