Quick Start

Build your first Sovrium app in 3 steps. From an empty file to a running application in under 5 minutes. Choose the approach that fits your workflow.

Choose your approach

Sovrium supports two configuration formats. YAML is great for simplicity; TypeScript gives you full type safety and autocompletion.

Option A — YAML + CLI

The simplest path. Create an app.yaml file and run it with the Sovrium CLI:

1

Create a config file

Start with the simplest valid configuration — just a name. 

name: my-app
2

Add data tables

Define your data models with typed fields, options, and validation. 

name: my-app

tables:
  - id: 1
    name: tasks
    fields:
      - id: 1
        name: title
        type: single-line-text
        required: true
      - id: 2
        name: status
        type: single-select
        options:
          - label: To Do
            color: gray
          - label: In Progress
            color: blue
          - label: Done
            color: green
3

Start the server

Run the dev server and visit http://localhost:3000 to see your app. 

sovrium start app.yaml
💡

Add more as you go

Start small with just tables. Then progressively add theme, auth, pages, and analytics as your needs grow.

Option B — TypeScript + Bun

The power-user path. Import Sovrium as a library in a TypeScript file and run it with Bun:

1

Create an app.ts file

Import the start function and pass a typed configuration object. 

import { start } from 'sovrium'

await start({
  name: 'my-app',
})
2

Add data tables

Extend the configuration with typed fields, options, and validation — with full autocompletion. 

import { start } from 'sovrium'

await start({
  name: 'my-app',
  tables: [
    {
      id: 1,
      name: 'tasks',
      fields: [
        {
          id: 1,
          name: 'title',
          type: 'single-line-text',
          required: true,
        },
        {
          id: 2,
          name: 'status',
          type: 'single-select',
          options: [
            { label: 'To Do', color: 'gray' },
            { label: 'In Progress', color: 'blue' },
            { label: 'Done', color: 'green' },
          ],
        },
      ],
    },
  ],
})
3

Run with Bun

Execute your TypeScript file directly. Visit http://localhost:3000 to see your app. 

bun run app.ts
💡

Why TypeScript?

TypeScript gives you autocompletion for every property, compile-time validation of field types, and the full power of Bun as your runtime. Ideal for developers who prefer code over config files.

←InstallationOverview→