README

A clean, class-based system for organizing Laravel routes.

Say goodbye to bloated web.php files. With RouteArchitect, you define routes as classes — reusable, composable, and auto-discoverable. Perfect for apps with complex structures, admin panels, or modular APIs.

Why RouteArchitect?

• Keeps your web.php clean and maintainable.
• Supports deeply nested and reusable route groups.
• Generates route names, views, prefixes, and URLs automatically.
• Easily extendable, testable, and auto-discoverable.
• Ideal for complex apps with admin panels, modules, or APIs.

Example:

class AdminRouteArchitect extends RouteArchitect
{
    protected string $identifier = 'admin';

    protected array $routeArchitects = [ DashboardRouteArchitect::class ];
}

// Generates route name: admin.dashboard
class DashboardRouteArchitect extends RouteArchitect
{
    protected string $identifier = 'dashboard';

    protected array | string | null $action = [ DashboardController::class, "index" ];
}

// In another controller...
return view(route_architect()->getSequenceEntry(DashboardRouteArchitect::class)->view);

Quick Start

Install the package:

composer require tea-aroma/route-architect

Generate your first RouteArchitect class:

php artisan make:route-architect AdminRouteArchitect --identifier=admin

This command will create a new class in app/RouteArchitects:

namespace App\RouteArchitects;

use TeaAroma\RouteArchitect\Abstracts\RouteArchitect;

/**
 * AdminRouteArchitect.
 */
class AdminRouteArchitect extends RouteArchitect
{
    /**
     * The identifier.
     *
     * @var string
     */
    protected string $identifier = 'admin';
}

Notice: By default, the identifier is derived from the class name if not specified.

Registering routes

• Automatically (default) — set auto_scan = true in the config.
• Manually — call route_architect()->register() with your RouteArchitect class.

// web.php

route_architect()->register(AdminRouteArchitect::class);

Configuration

You can publish the configuration file:

php artisan vendor:publish --provider="TeaAroma\RouteArchitect\Providers\RouteArchitectServiceProvider" --tag=config

Available options in config/route-architect.php:

Available properties

When you define your RouteArchitect class, you can configure it using the following properties:

License

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