README

🚀 Introduction

Welcome to my personal laravel installer YUI! This setup is designed for developers who want a lightweight, modern, and efficient foundation for building Laravel applications with a React frontend powered by Inertia.js.

This kit is JavaScript-first, using JSX instead of TSX, making it accessible to developers who prefer plain JavaScript over TypeScript. It includes React 19, TailwindCSS 4, and Breeze for simple authentication and scaffolding.

🎯 Features

✔️ Laravel – Laravel provides a complete ecosystem for web artisans.
✔️ Laravel Breeze – Lightweight authentication with Inertia.js.
✔️ Laravel Pulse – delivers at-a-glance insights into your application's performance and usage.
✔️ Orion – The simplest way to create REST API with Laravel.
✔️ Inertia.js – Create modern single-page React, Vue, and Svelte apps using classic server-side routing.
✔️ React 19 + JSX – Simple, clean, and TypeScript-free.
✔️ React Icons – Include popular icons in your React projects easily with react-icons.
✔️ TanStack Query – Powerful asynchronous state management for TS/JS.
✔️ Zustand – A small, fast, and scalable bearbones state management solution.
✔️ Laravel-Spatie-permission – Associate users with roles and permissions.
✔️ TailwindCSS 4 – Modern styling with utility-first CSS.
✔️ Vite-Powered – Lightning-fast HMR for smooth development.
✔️ Pre-configured Testing – Includes PHPUnit & Pest.
✔️ Quick Setup – Get started in minutes!

🛠 Getting Started

1️⃣ Install

composer global require luis-developer-08/yui-installer

2️⃣ Create a New Laravel Project

yui new my-laravel-app

🎉 Your application is now up and running!

⚡ Create Inertia Components Easily

This starter kit includes a custom Artisan command to quickly generate Inertia.js React components:

🏗️ Generate a New Component

php artisan make:inertia Components/MyComponent

This will create a new file at resources/js/Components/MyComponent.jsx with a basic component template.

📂 File Structure

resources/js/Components/MyComponent.jsx

✨ Example Generated Component

import React from "react";

const MyComponent = () => {
    return <div>{/* MyComponent component */}</div>;
};

export default MyComponent;

This command ensures that components are placed in the correct directory and prevents overwriting existing files. It also automatically opens the newly created file for editing.

⚡ Create Orion Controllers Easily

This starter kit also includes a command to quickly generate Orion controllers along with their associated models:

🏗️ Generate a New Orion Controller

php artisan make:orion PostController

This will create:

• app/Http/Controllers/Orion/PostController.php
• app/Models/Post.php (if it doesn’t exist)
• Adds a route in routes/api.php

📂 File Structure

app/Http/Controllers/Orion/PostController.php
app/Models/Post.php

✨ Example Generated Controller

<?php

namespace App\Http\Controllers\Orion;

use Orion\Http\Controllers\Controller;
use App\Models\Post;

class PostController extends Controller
{
    protected $model = Post::class;
}

🔗 Auto-Registered Route in routes/api.php

Orion::resource('posts', \App\Http\Controllers\Orion\PostController::class)->middleware(['auth', 'web']);

This command ensures that controllers are correctly placed, models are created if missing, and routes are automatically registered.

📖 Documentation

For more details on YUI, visit the official YUI Website.

🤝 Contributing

We welcome contributions! Check out the Laravel contribution guide to get involved.

📜 Code of Conduct

Be kind and respectful. Please follow Laravel's Code of Conduct.

⚖️ License

This starter kit is open-source under the MIT license.