Aller au contenu

Installer pour le développement

Facet tourne depuis les sources sur Linux et macOS. Si vous voulez seulement essayer le produit, prenez la pile Docker Compose — voir Déployer en production.

Installez d’abord ces outils. Le tableau dit à quoi chacun sertà :

Outil Notes
Crystal 1.21 La chaîne d’outils du projet. Le shard agent-cr demande Crystal 1.19 ou plus récent.
PostgreSQL 14 ou plus récent Une instance pour l’application. La fonction ulid() demande PostgreSQL 14.
Redis Obligatoire. Il sert le bus d’événements, les sessions, les codes OAuth et les limites de débit.
Node.js 20+ et pnpm Frontend, paquet CLI, lanceur E2E. pnpm uniquement — les lockfiles sont des pnpm-lock.yaml.
Caddy Le proxy de développement. scripts/dev l’attend dans le PATH.
En-têtes Lua 5.4 ou 5.5 Le shard lua lie la bibliothèque système (liblua5.4-dev sur Debian/Ubuntu).

Clonez le dépôtà :

Fenêtre de terminal
git clone https://github.com/wearefacet/facet.git
cd facet

Deux fichiers portent la configuration :

  • config.dev.yml — la configuration du backend (base de données, Redis, mail, artifacts).
  • le .env à la racine — les adresses partagées, notamment BACKEND_URL.

Lancez les trois scripts dans l’ordreà :

Fenêtre de terminal
scripts/init # crée la base, applique les migrations, initialise les doctypes de base + un admin de dev
scripts/import-fixtures # facultatif : charge les domaines d'exemple CRM / RH / production
./scripts/dev # Caddy + backend + frontend sur https://facet.localhost:3443

scripts/init lance facet db_reset seed:dev : il supprime puis recrée la base, applique toutes les migrations, et initialise le schéma de base avec un administrateur de développement.

Ouvrez https://facet.localhost:3443, puis connectez-vous avec l’administrateur créé par l’initialisation : admin@example.tld / admin. Ce compte ne sert qu’au développement, sur des données que vous pouvez effacer à tout moment — la plateforme le refuse en production.

Trois processus servent la pileà :

SvelteKit frontend SvelteKit frontend

./scripts/dev démarre tous les processus dans un seul terminal. Pour le mode brut à deux ports, utilisez ./scripts/dev --no-caddy (backend :3000, frontend :5173).

Backend (à la racine du dépôt) :

Commande But
make check Le passage de compilation, sans binaire. Le signal le plus rapide sur les erreurs de types.
make build / make build_release Le binaire serveur dans build/.
make run Backend seulement.
make test La suite de specs complète. Démarre d’abord un PostgreSQL jetable sur le port 5433.
bin/ameba Le linter Crystal.

Frontend (dans frontend/) :

Commande But
pnpm check svelte-check — types, syntaxe Svelte, accessibilité.
pnpm lint Prettier + ESLint.
pnpm test Vitestà : logique pure + fonctions play des stories Storybook.
pnpm storybook L’atelier de composants.