Installation

Install Sovrium globally or as a project dependency. Supports npm, Bun, yarn, and pnpm.

Prerequisites

Sovrium requires Node.js 18+ or Bun 1.0+. A PostgreSQL database is needed for data persistence (tables, auth).

Install Sovrium globally to use the sovrium command from anywhere:

# With npm
npm install -g sovrium

# With Bun (recommended)
bun add -g sovrium

Or add Sovrium as a dependency in an existing project:

# With npm
npm install sovrium

# With Bun (recommended)
bun add sovrium

# With yarn
yarn add sovrium

# With pnpm
pnpm add sovrium

Check that Sovrium is installed correctly:

sovrium --version

Sovrium reads a YAML or JSON configuration file. Create an app.yaml in your project root:

name: my-app
version: 1.0.0
description: My first Sovrium application

💡

Sovrium supports both .yaml/.yml and .json files. YAML is recommended for readability.

If your app uses tables or auth, set the DATABASE_URL environment variable:

export DATABASE_URL="postgresql://user:password@localhost:5432/myapp"

💡

If you only use pages and theme (no tables or auth), Sovrium works without a database. Run sovrium static app.yaml to generate a static site.

←Introduction Quick Start→