Skip to main content
View as Markdown

Démarrage rapide

Créez votre première application Sovrium en quelques minutes. De zéro à une application opérationnelle. Choisissez l'approche qui correspond à votre flux de travail.

Choisissez votre approche

Sovrium prend en charge deux formats de configuration. Le YAML est parfait pour la simplicité ; TypeScript offre un typage complet et l'autocomplétion.

Option A : YAML + CLI

La voie la plus simple. Installez le CLI Sovrium, rédigez une configuration YAML et démarrez le serveur :

  1. Installer le CLI — Installez Sovrium globalement avec Bun pour obtenir la commande sovrium.

    bun add -g sovrium

  2. Créer un fichier de configuration — Créez un fichier app.yaml avec la configuration valide la plus simple : juste un nom.

    name: my-app

  3. Ajouter des tables de données — Définissez vos modèles de données avec des champs typés, des options et de la 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: [To Do, In Progress, Done]

  4. Démarrer le serveur — Lancez le serveur de développement et rendez-vous sur http://localhost:3000 pour voir votre application.

    sovrium start app.yaml

Option B : TypeScript + Bun

La voie pour les utilisateurs avancés. Créez un projet Bun, ajoutez Sovrium comme dépendance et rédigez du code fortement typé :

  1. Initialiser un projet — Échafaudez un nouveau projet Bun avec bun init et entrez dans le répertoire.

    bun init my-app && cd my-app

  2. Ajouter Sovrium — Installez Sovrium comme dépendance du projet.

    bun add sovrium

  3. Rédiger votre application — Ouvrez index.ts et importez la fonction start avec une configuration minimale.

    import { start } from 'sovrium'

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

  4. Ajouter des tables de données — Enrichissez la configuration avec des champs typés, des options et de la validation, avec une autocomplétion complète.

    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: ['To Do', 'In Progress', 'Done'],
        },
      ],
    },
  ],
})

  5. Exécuter votre application — Exécutez index.ts avec Bun. Rendez-vous sur http://localhost:3000 pour voir votre application.

    bun run index.ts

Et ensuite ?

Maintenant que votre application est opérationnelle, explorez la référence du schéma pour ajouter davantage de fonctionnalités :