Application structure

A freshly scaffolded Tyravel app looks like this:

my-app/
├── tyravel.json
├── package.json
├── .env
├── config/
│   ├── app.ts
│   ├── database.ts
│   └── auth.ts
├── database/
│   ├── migrations/
│   ├── factories/
│   └── seeders/
├── resources/
│   └── views/
└── src/
    ├── main.ts
    ├── routes/
    ├── controllers/
    ├── providers/
    │   └── app-service-provider.ts
    └── models/

Service providers

Providers register bindings and boot framework features. Register them in main.ts before app.boot():

app.register(ConfigServiceProvider);
app.register(DatabaseServiceProvider);
app.register(AuthServiceProvider);
app.register(AppServiceProvider);

AppServiceProvider is where application-specific bindings, middleware aliases, and route facades live.

Async-first register() / boot()

ServiceProvider.register() and ServiceProvider.boot() may return void or Promise<void>. Tyravel is moving to an async-native runtime: prefer async register() and async boot() whenever a hook touches the filesystem, config, or other I/O.

Application.boot() always awaits each provider hook in registration order:

1. Every provider's register() runs (in order) before any boot() runs.
2. Every provider's boot() runs (in order) after all register() hooks finish.

Synchronous hooks remain valid for quick, non-blocking setup (for example this.app.instance(...)). Do not call blocking sync FS or network APIs from provider hooks — use the async variants from node:fs/promises or driver APIs that return promises.

export class AppServiceProvider extends ServiceProvider {
  override async register() {
    this.app.instance('app.name', 'Tyravel');
  }

  override async boot() {
    // Route facades, middleware aliases, etc.
  }
}

Package contributions

Packages can ship migrations and default config:

export class LontarServiceProvider extends ServiceProvider {
  override async register() {
    this.loadMigrationsFrom(join(import.meta.dirname, 'database/migrations'));
    await this.mergeConfigFrom(join(import.meta.dirname, '../config/lontar.js'), 'lontar');
  }
}

Register the package provider from AppServiceProvider so tyravel migrate and config loading pick it up.