1.5 KiB
1.5 KiB
Development Guide
Prerequisites
- Node.js 20+
- pnpm 10+
- macOS/Linux/Windows
Install
pnpm install
.npmrc must keep:
shamefully-hoist=true
Main Dev Entry Points
# Recommended local desktop workflow
pnpm dev
# Service-specific
pnpm dev:desktop
pnpm dev:gateway
pnpm dev:web
# Full local stack with isolated dev data
pnpm dev:local
What Each Command Does
pnpm dev: builds shared packages, then runstypes + utils + core + desktopwatch flow.pnpm dev:desktop: Electron desktop only.pnpm dev:gateway: NestJS WebSocket gateway (PORT, default3000).pnpm dev:web: Next.js web app (3000by script).pnpm dev:local: gateway + web + desktop with dev-safe env defaults.
Important Environment Variables
SMC_DATA_DIR: override runtime data root (default~/.super-multica)GATEWAY_URL: gateway endpoint for desktop/CLI hub connectionMULTICA_API_URL: required by web/data toolsPORT: gateway/server portMULTICA_WORKSPACE_DIR: override workspace rootMULTICA_RUN_LOG=1: enable structured run-log output
Local Full-Stack Notes
pnpm dev:local expects root .env with Telegram credentials:
cp .env.example .env
At minimum set:
TELEGRAM_BOT_TOKEN
Build / Quality
pnpm build
pnpm typecheck
pnpm test
pnpm test:coverage
Useful Reset Commands
# Reset default + dev data dirs used by desktop scripts
pnpm dev:desktop:reset
# Reset and relaunch desktop onboarding flow
pnpm dev:desktop:fresh
pnpm dev:desktop:onboarding