Documentation

Point d'entrée de la documentation de @lrvo/core, découverte, démarrage, guides, référence, architecture et contribution.

LRVO livre en une commande ce qu'une application d'entreprise met des semaines à écrire : comptes et connexion, rôles et permissions, interface d'administration, courriels, fichiers, paiements, mise en production.

L'admin est extensible : on y greffe ce qu'on veut, sans modifier le core. Ce qui reste à écrire, c'est votre projet.

Qu'est-ce que LRVO développe cette page en trois minutes de lecture.

Par où commencer

Vous voulez	Aller à
Comprendre ce que c'est, sans rien installer	Découverte, quatre pages à lire dans l'ordre.
Monter un projet et le voir tourner	Installation.
Résoudre un besoin précis	Guides, un cas d'usage par page.
Trouver une signature, une option, une variable	Référence.

Comment lire cette documentation

Elle est organisée en sept sections :

Section	Contenu
Découverte	Ce qu'est la plateforme, son vocabulaire, son fonctionnement et ce qu'elle permet de construire. Sans installation.
Démarrage	Parcours pas à pas, de l'installation au premier module. À lire dans l'ordre.
Guides	Un cas d'usage par page. À lire au besoin.
Référence	Détail technique de chaque module, fonction, CLI et variable d'environnement.
Architecture	Principes, frontières serveur/client, build, sécurité, design system.
Contribution	Conventions de code, de rédaction, de commit et procédure de publication.
Modules	Usage des modules officiels `@lrvo/module-*`, installation, configuration et API.

Chaque section a un index.md qui sert de table des matières.

Où trouver cette documentation

Elle vit dans le dépôt sous docs/, et elle est livrée dans le package npm sous node_modules/@lrvo/core/dist/docs/. Un projet qui installe @lrvo/core a donc la documentation de la version exacte qu'il utilise, hors ligne.

Prérequis

Node.js 20 ou plus (imposé par le SDK Resend v6, livré quel que soit le fournisseur de courriel actif).
PostgreSQL 14 ou plus.
Next.js 14 ou plus, React 19.
Accès au registre npm privé https://registry.lrvo.app/.

Conventions de cette documentation

Le contenu est en français, le code en anglais. Voir Langue.
Chaque page porte un frontmatter title / description.
Les chemins src/... désignent le dépôt @lrvo/core. Les chemins app/... désignent le projet consommateur généré par npx @lrvo/start.
Les exemples supposent un projet déjà structuré par @lrvo/start.

Signaler une faille de sécurité

Ne pas ouvrir d'issue publique. Voir SECURITY.md à la racine du dépôt.

Licence

LRVO est un produit commercial d'ACARY. Ce n'est pas un logiciel libre. L'usage de chaque paquet est régi par le contrat de licence livré avec lui, dans son fichier LICENSE. Le modèle et ses conséquences sur le code sont expliqués dans Licence et propriété.