Skip to content

Create a Project

Run the official project creation command:

Terminal window
pnpm create routa-ts@latest

By default, the scaffolder creates a TypeScript Routa app with route examples, Biome configuration, OpenAPI baseline files, and scripts for checking, building, and running the API.

  • TypeScript app structure
  • Routa route examples
  • Biome configuration
  • Scripts for checking and building the API
  • OpenAPI baseline and generated metadata files
  1. Enter the project directory.

    Terminal window
    cd routa-app
  2. Install dependencies if you did not pass --install.

    Terminal window
    pnpm install
  3. Run the development server.

    Terminal window
    pnpm dev

Generated apps follow this shape:

  • biome.json
  • Directorysrc/
    • routa.ts
    • Directoryroutes/
      • Directorystatus/
        • route.ts
        • schemas.ts
  • Directory.routa/
    • manifest.json
    • openapi-baseline.json
    • routes.gen.ts
  • openapi.yaml
  • package.json
  • tsconfig.json

Use the generated routes as the starting point for your HTTP contract.