UniFam Documentation

Environnement de développement

Préparer son poste pour développer sur le Core UniFam.

Prérequis

  • Node.js 24 ou supérieur.
  • Git.
  • Docker et Docker Compose, pour la base de données et les services annexes.
  • Un accès aux dépôts Forgejo, avec un token d'accès personnel pour l'authentification git.

Sous Windows, un shell Unix (WSL2 ou Git Bash) simplifie l'exécution des scripts de ce guide.

Récupérer le code

# TODO : URL du serveur Forgejo
git clone <url>/unifam-core-sdk.git
git clone <url>/unifam-core-backend.git
git clone <url>/unifam-core-frontend.git

Démarrer

npm install
docker compose up -d db   # TODO : nom du service à confirmer
npm run start:dev         # TODO : scripts à confirmer

Définissez les variables d'environnement décrites dans la référence, avec UNIFAM_APP_ENV=development.

Accéder au registre privé

Les paquets @unifam/* sont publiés sur le registre npm privé du serveur Forgejo. Configurez-le avec votre token d'accès personnel :

npm config set @unifam:registry https://<serveur-forgejo>/api/packages/UniFam/npm/
npm config set -- '//<serveur-forgejo>/api/packages/UniFam/npm/:_authToken' "<token>"

Voir SDK pour le détail.

Travailler avec le SDK

Le SDK est écrit en TypeScript strict avec Zod, au format ESM. Il est construit avec tsdown, testé avec Vitest et vérifié avec ESLint, via npm.

Quand vous modifiez un contrat dans unifam-core-sdk, reconstruisez-le puis relancez le backend et le frontend qui le consomment (TODO : procédure de liaison locale à documenter).

On this page