For Developers

Cyd is a desktop app for Windows, Mac, and Linux written in Node.js. To run Cyd locally, you need is Node.JS LTS for your operating systems and pnpm.

Install dependencies.

pnpm install

Configure your Cyd environment to use "open" mode. This disables the server, which allows outside contributors to build features.

pnpm config-open

Run Cyd:

pnpm start

To make it so devtools automatically opens, and so each embedded webview has a separate devtools window open, set the environment variables CYD_DEV to 1:

CYD_DEV=1
pnpm start

Run the tests:

# Node.js tests
pnpm test

Other server modes

If you're an outside contributor you'll want to use "open" mode, as described above.

If you're part of Lockdown Systems and you need to test functionality that uses the server, you need "local", "dev", or "prod" mode:

# local mode: use a locally-hosted server at localhost:5000
pnpm config-local

# dev mode: use the dev server at dev-api.cyd.social
pnpm config-dev

# prod mode: use the prod server at prod-api.cyd.social
pnpm config-prod