Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.19 KB

DEVELOPMENT.md

File metadata and controls

55 lines (37 loc) · 1.19 KB

Developing Cyd

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

Install dependencies.

npm install

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

npm run config-open

Run Cyd:

npm run 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
npm run start

Run the tests:

# Node.js tests
npm run test

# Vue.js component tests
npm run test:components

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
npm run config-local

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

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