DEVELOPERS

Development

Build EveryOS, run checks and contribute to the project.

Run the source

Use Node.js 26 and pnpm 12 on macOS or Linux. The development desktop opens at http://127.0.0.1:5173 and the console prints a temporary setup token. Linux-only features are reported as unavailable on macOS. This source workflow is separate from packaged installation.

Bash
git clone https://github.com/goktugcy/everyos.git
cd everyos
pnpm install
pnpm dev

Validate your change

pnpm check runs formatting checks, lint, type checks and tests. Build before running the browser tests. On the first browser-test run, install Chromium with pnpm exec playwright install --only-shell chromium. Tests use disposable state and must not target your production workspace.

Bash
pnpm check
pnpm build
pnpm test:e2e

Explore the architecture

The project combines a React client, Hono API, SQLite database, privileged agent and independent update worker. Read CONTRIBUTING.md and the architecture guide before changing a trust boundary. For third-party desktop apps, start with docs/app-sdk in the repository.