Build with Leaf MVC

When your app needs separate places for routes, request handling, data, and templates, start with Leaf MVC. It uses the same Leaf APIs as the basic setup, with a directory structure for organizing your code.

// Quickstart

Bash

Install the CLI, create a project

composer global require leafs/cli

leaf create my-app --mvc

Run it

cd my-app && leaf serve

Your app is live athttp://localhost:5500

~30s

Building a small API or a few pages? The basic setup is a simpler starting point.

Your first controller and route

Controllers group the methods that handle requests. Create one for users:

bash

leaf g:controller users

This creates app/controllers/UsersController.php. Its index() method can return a JSON response:

php

<?php

namespace App\Controllers;

class UsersController extends Controller
{
    public function index()
    {
        return response()->json([
            'message' => 'Hello from Leaf MVC'
        ]);
    }
}

Add a route in app/routes/index.php to call that method:

php

app()->get('/users', 'UsersController@index');

Visit http://localhost:5500/users to see the response. Leaf matches the URL, calls UsersController::index(), and sends the JSON back to the browser.

Where your code goes

The main application folders are:

text

app/
├── controllers/
├── database/
├── models/
├── routes/
└── views/
public/

Routes map URLs to controller methods. Controllers handle the request, use models to work with data, and return a response. For HTML pages, templates live in app/views/.

01 / ModelWork with your dataPut model classes in app/models and database migrations in app/database.

02 / ViewRender a pageKeep page templates in app/views and serve assets from public.

03 / ControllerHandle the requestGroup related actions in app/controllers and connect them to routes.

As your route list grows, you can split it into files such as _auth.php or _api.php in app/routes/. See MVC routing for route partials and middleware.

Add the features you need

Use models for database records, authentication for user accounts, and billing for payments and subscriptions. Each guide covers the setup and configuration for that feature.

For the frontend, you can render templates on the server or use a JavaScript framework. The frontend guide covers Blade, Inertia, and Vite integration.

Working with an AI assistant

Leaf CLI creates .leaf/CONTEXT.md with context about your project. Ask your coding assistant to read it before making changes, and point it to the feature you want to work on.

For example:

Read .leaf/CONTEXT.md, then add a users endpoint. Follow the existing route and controller conventions, and use the project's user model.

If your assistant cannot access the project folder, run:

bash

leaf context

Paste the output along with your request. See AI in Leaf for more on project context.

Deploy your app

Configure your production environment and point your web server at the public/ directory. The deployment guide covers hosting options and server setup.

If you get stuck, ask in the Leaf Discord server.

What to read next

01 / RoutesMVC routingConnect URLs to controllers, split route files, and add middleware.Open routing 02 / RequestsControllersGenerate controllers and organize the actions that handle requests.Open controllers 03 / DataModelsQuery records and define relationships between your data.Open models 04 / PagesFrontendBuild pages with templates or connect a JavaScript frontend.Open frontend

Build with Leaf MVC ​

Your first controller and route ​

Where your code goes ​

Add the features you need ​

Working with an AI assistant ​

Deploy your app ​

What to read next ​