KelnaKelnaDocumentation
Parcourir la documentation

DéveloppeursVersion tablette · pilote

Démarrer en développement

Exécutez le socle local et testez une modification avec des données fictives.

Prérequis

Le dépôt utilise Node.js 24 à partir de 24.22.0, pnpm 11.10.0 et Docker avec Compose. Utilisez les versions fixées par .node-version et packageManager dans le dépôt.

Le code est en TypeScript strict : React et Vite pour le front, Fastify pour l’API et PostgreSQL pour les données. N’introduisez aucune dépendance sans vérifier sa licence.

Lancer l’application

Le front écoute par défaut sur http://127.0.0.1:4317 et transmet /api vers l’API locale. L’API utilise le port 3001 et PostgreSQL le port 55432. API_PORT et WEB_PORT permettent d’adapter les ports.

setup:local crée une configuration privée si elle manque, sans afficher les secrets. Gardez-la tant que le volume de base existe ; changer un mot de passe dans un fichier ne modifie pas le volume déjà initialisé.

Exemple de code
pnpm install --frozen-lockfile
pnpm setup:local
pnpm db:up
pnpm db:migrate
pnpm dev

Préparer les accès et le plan

Le dépôt fournit les commandes opérateur auth:invite, access:setup et floorplan:import. Elles préparent le compte, l’organisation, l’établissement et le plan fictif ; elles ne sont pas des routes publiques d’inscription ou d’import.

Pour relire uniquement les interfaces, pnpm demo lance une salle fictive en mémoire sans compte ni base. Cette démonstration ne valide pas l’API persistante et ne conserve aucune observation.

Valider une modification

Les tests d’intégration et de navigateur nécessitent la base démarrée et migrée. Arrêtez l’API de développement si elle occupe le port utilisé par les tests. La commande verify:isolated fournit aussi une validation avec une base jetable.

La documentation et ses exemples doivent évoluer dans la même modification que les contrats API. Le contrat téléchargeable est produit au build sans connexion à la base ni lecture de secrets.

Exemple de code
pnpm lint && pnpm typecheck && pnpm test
pnpm test:integration
pnpm e2e

Besoin d’un coup de main ?

Indiquez l’étape qui bloque et le message affiché. Gardez vos mots de passe et codes de connexion privés.

Contacter l’équipe Kelna