Cloner et lancer

Comment cloner arka-deck, l’installer, et le lancer en mode développement.

Prérequis

Node.js ≥ 20.19.0 (nvm recommandé pour gérer plusieurs versions).
Git moderne avec support DCO.
Quelques centaines de Mo d’espace disque.
Au moins une clé API auprès d’un provider IA (Anthropic, Google, OpenAI) pour vraiment utiliser l’app.

Clone

git clone https://github.com/arka-squad/arka-deck.git
cd arka-deck

Si vous comptez contribuer :

git remote add upstream https://github.com/arka-squad/arka-deck.git
git remote set-url origin <votre-fork>

Install

npm install
npm --prefix adapters/inbound/web/ui install
npm --prefix addons/cortex-lite install

Le projet est un monorepo informel : la racine + un sous-package UI + un sous-package Cortex Lite. Les trois npm install couvrent l’intégralité des dépendances.

Premier lancement

npm run arka:start

Le script arka-cli.mjs :

Build l’UI si besoin (Vite production).
Spawn bin/arka-deck détaché.
Redirige les logs vers .arka-web.log.
Écrit le PID dans .arka-pid.
Ping /api/health jusqu’à readiness.

Ouvrez http://127.0.0.1:3117 dans votre navigateur.

Mode développement UI (hot reload)

Pour développer l’UI avec rechargement à chaud :

# Terminal 1 — serveur Fastify
npm run arka:start

# Terminal 2 — UI Vite dev server
npm run dev:ui

L’UI Vite tourne sur un port séparé (par défaut 5173) et proxifie les appels API vers 127.0.0.1:3117.

Activer les hooks Git locaux

git config core.hooksPath .githooks

Active le pre-commit qui :

Lint les fichiers stagés.
Vérifie le sign-off DCO.
Refuse les fichiers internes (.input/, .claude/ sauf exceptions).

Vérifier l’environnement

npm run typecheck -- --pretty false
npm run lint
npm test

Si tout est vert, votre environnement est prêt à contribuer.

Arrêter

npm run arka:stop

Ou simplement Ctrl+C dans le terminal du serveur si vous ne l’avez pas détaché.

Voir aussi

Conventions de contribution : ./conventions (à venir)
CLI référence : ../reference/cli
Variables d’env : ../reference/variables-env