Local Development
Set up the Noema workspace and run the checks developers need.
This guide covers the developer workflow for the Noema repository.
Prerequisites
| Tool | Version | Notes |
|---|---|---|
| Node.js | 18+ | Required by the TypeScript workspace and desktop app. |
| pnpm | 8+ | The root project pins pnpm 10.33.2. |
| Git | Current stable | Required for normal contribution workflow. |
| Desktop OS | macOS, Windows, or Linux | Required when testing the Electron desktop app. |
Install
From the repository root:
pnpm installThe workspace currently includes packages/* and apps/*.
Common Commands
pnpm build
pnpm test
pnpm lint
pnpm --filter @noema/sdk build
pnpm --filter @noema/desktop buildEnvironment Files
The desktop runtime reads provider configuration from environment files such as apps/desktop/.env. Keep secrets out of docs, commits, screenshots, and issue reports.
Example placeholder format:
LLM_BASE_URL=https://api.example.com/v1
LLM_API_KEY=example-token
TASK_MODEL=example-task-modelGenerated Files
Do not commit local dependency folders or build outputs:
node_modules/
.turbo/
dist/If a generated file appears in git status, verify whether it belongs in source control before committing.