Getting started

Create a new application

npx tyravel new my-app
cd my-app
npm install
tyravel serve

Visit http://127.0.0.1:3000.

Run from the monorepo

If you are developing Tyravel itself, build the workspace first:

npm install
npm run build

Then try the reference app:

cd examples/hello-world
npm install
tyravel serve

Application entry point

Every app boots through src/main.ts:

import { Application, ConfigServiceProvider, Route, serve } from '@tyravel/core';
import { AppServiceProvider } from './providers/app-service-provider.js';
import './routes/web.js';

const app = new Application();
app.register(ConfigServiceProvider);
app.register(AppServiceProvider);
await app.boot();

serve(app);

Routes are registered in src/routes/web.ts using the Route facade after setRouteApplication(app) is called from your provider.

CLI essentials

tyravel list                    # Available commands
tyravel serve                   # Dev server (reads tyravel.json)
tyravel migrate                 # Run migrations
tyravel make:controller User    # Generate a controller
tyravel make:model Post         # Generate a model
tyravel auth:install            # Scaffold auth (User, routes, migrations)

Next steps

• Application structure — folders, providers, and config
• Routing — groups, middleware, and controllers
• Database & ORM — models, migrations, and relationships