Aller au contenu

Documentation

Pour les développeurs

Pile technique, commandes, structure du dépôt, règles et déploiement.

Workly est une application Next.js 16 (App Router, React 19, TypeScript) avec une base SQLite (better-sqlite3, Drizzle ORM, migrations SQL versionnées), Better Auth pour les comptes, Tailwind CSS 4 et des composants shadcn/ui. Deux processus de fond (worker et worker-modules) traitent le mail, les notifications, l’IA et la vidéo.

Lancer en local

npm ci
cp .env.example .env            # puis renseigner DATA_DIR, BETTER_AUTH_SECRET, SECRETS_KEYS
npm run db:migrate
npm run comptes -- lien-configuration
npm run dev                      # http://localhost:3100
Node.js 22 ou plus récent ; le lien de configuration crée le compte du propriétaire.

Vérifier avant de livrer

npm run verifier     # types, lint, tests, build autonome
npm run mcp:check    # catalogue MCP à jour
La règle du projet : rien n’est rendu tant que `npm run verifier` n’est pas vert.

Structure du dépôt

  • src/app : routes (pages publiques, /[espace]/…, API) ; src/components : interface ; src/server : contexte, droits, dépôts et services ; src/lib : utilitaires partagés (temps, i18n, documentation).
  • drizzle : migrations SQL ; scripts : CLI (comptes, migration, workers, sauvegarde) ; tests : Vitest ; deploy : unités systemd et scripts de la plateforme.
  • AGENTS.md : règles à lire avant toute modification ; docs/ : cahier des charges, décisions techniques et guides par module.

Déploiement

La production tourne sur le VPS du propriétaire derrière sa plateforme personnelle : la branche main est déployée dans un conteneur qui récupère un artefact Next compilé sur le Mac et vérifie que les empreintes de toutes les sources correspondent au dépôt. Une différence refuse le build et conserve la version active. La base, les secrets et les workers restent sur l’hôte.

Dernière mise à jour :