Quick Start

This guide will help you create your first CRUD page in 5 minutes.

Create a Module

php artisan module:make Blog

Create Migration

php artisan module:make-migration create_posts_table Blog

Edit the migration file:

Schema::create('posts', function (Blueprint $table) {
    $table->id();
    $table->string('title');
    $table->text('content')->nullable();
    $table->boolean('status')->default(true);
    $table->timestamps();
});

Run migration:

php artisan migrate

Create Model

php artisan module:make-model Post Blog

Edit the model:

<?php

namespace Modules\Blog\Models;

use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    protected $fillable = ['title', 'content', 'status'];
}

Create Controller

php artisan module:make-controller PostController Blog

Edit the controller:

<?php

namespace Modules\Blog\Http\Controllers;

use Lartrix\Controllers\CrudController;
use Lartrix\Schema\Components\NaiveUI\{Input, SwitchC};
use Lartrix\Schema\Components\Business\CrudPage;
use Modules\Blog\Models\Post;

class PostController extends CrudController
{
    protected function getModelClass(): string
    {
        return Post::class;
    }

    protected function getResourceName(): string
    {
        return 'Post';
    }

    protected function listUi(): array
    {
        $schema = CrudPage::make('Post Management')
            ->apiPrefix('/blog/posts')
            ->columns([
                ['key' => 'id', 'title' => 'ID', 'width' => 80],
                ['key' => 'title', 'title' => 'Title'],
                ['key' => 'status', 'title' => 'Status'],
            ])
            ->search([
                ['Keyword', 'keyword', Input::make()]
            ]);

        return success($schema->build());
    }
}

Add Routes

Add to Modules/Blog/Routes/api.php:

use Illuminate\Support\Facades\Route;
use Modules\Blog\Http\Controllers\PostController;

Route::middleware(['auth:admin'])->group(function () {
    Route::resource('posts', PostController::class);
});

Add Menu

Log in to the admin panel, go to "System" -> "Menu Management", and add a new menu:

• Title: Post Management
• Path: /blog/posts
• Icon: document-text
• Permission: posts.list

Done

Refresh the admin panel — you will now see "Post Management" in the sidebar!

Next Steps

• Schema System - Deep dive into Schema building
• CrudController - Learn more CRUD features