1.5 KiB
Development
Yarn commands
yarn dev
Launch the app in development mode:
-
Transpiles the files in
src/and starts the main process. -
Runs a development server for the renderer (with hot module reload).
-
Starts tsc in watch mode to recompile the JS files used by the main process. Note that the main process is not restarted on changes automatically, you'll still need to restart the app manually – running tsc in watch mode is still useful to notice any errors.
yarn build
Build a binary for your current platform.
Note that our actual releases use a GitHub workflow that is similar to this, except it builds binaries for all the supported OSes and uses production signing credentials.
During development, you might find yarn build:quick helpful. It is a variant
of yarn build that omits some steps to build a binary quicker, something that
can be useful during development.
postinstall
When using native node modules (those written in C/C++), we need to ensure they
are built against electron's packaged node version. We use
electron-builder's install-app-deps command
to rebuild those modules automatically after each yarn install by invoking it
in as the postinstall step in our package.json.
lint and lint-fix
Use yarn lint to check that your code formatting is as expected, and that
there are no linter errors. Use yarn lint-fix to try and automatically fix the
issues.