Development environment
- Node.js 24 LTS (Node.js 22 remains accepted during the transition).
- pnpm 11 and Turborepo.
- Python 3.12, in an isolated virtual environment for Élise AI.
- Docker Engine 23+ and Docker Compose.
git clone https://github.com/Elise-OS/EliseOS.gitcd EliseOSpnpm installpnpm db:generatecp .env.example .envdocker compose up -dWithout Zigbee hardware, start only the core:
docker compose up -d bootstrap postgres mosquitto ai api worker dashboardOpen http://localhost:8080. The local assistant creates the first administrator.
To load the demonstration account, explicitly set MICHEL_DEMO_MODE=true. It must never be enabled in a published release.
Check a change
Section titled “Check a change”pnpm format:checkpnpm lintpnpm typecheckpnpm testpnpm buildRepository layout
Section titled “Repository layout”| Folder | Contents |
|---|---|
apps/api |
Élise Core: REST + SSE API, Prisma |
apps/worker |
Deferred jobs and notifications |
apps/dashboard |
Caregiver space (web) |
apps/mobile |
React Native / Expo app |
apps/ai |
Python learning service |
packages/contracts |
Shared schemas |
docker/ |
Home Assistant, Zigbee2MQTT, Mosquitto and Jitsi configuration |
appliance/ |
Raspberry Pi image build and systemd services |
install/ |
Installer and the elise command |
Diagnostics
Section titled “Diagnostics”compose.maintenance.yaml publishes maintenance ports, bound to loopback only:
docker compose -f compose.yaml -f compose.maintenance.yaml up -d