Make sure you have Node.js installed (with npm). Then, run npm install. You
will need to do this after cloning the repository, and every time package.json
changes.
Optionally, you can use nvm to manage your local Node versions. This will ensure consistency between local and release environments. The latest LTS version should always work.
Editor support is provided for Visual Studio Code, with features such as import sorting configured out of the box. Configure the Prettier extension for automatic code formatting.
npm run start:rendererServe the React application used by the renderer process on localhost:3000.npm run start:mainBuild and run the Electron application. Make sure that the React application is being served in the background. If you see a blank screen, you probably forgot to runnpm start:renderer.npm run db:migrateExecute all pending database migrations.npm run db:rollbackRevert the last executed migration. Use this command to test yourdown()method.npm run db:drop☢️ the database. Can come in handy if something goes wrong while developing migrations.npm run lintCheck the codebase for linter errors. Used by CI.npm run formatFormat the codebase using Prettier. Use this script if CI complains.npm run storybookStart Storybook on localhost:9000.scripts/build.shPackage the application for your local development OS. If you're integrating with native modules, this will come in handy as a preflight check.npm run packagePackage the application for Windows, our target platform. Will attempt to cross-compile on Linux / macOS. You will need to run the above build script first.npm run deploySame asnpm run package, but also attempt to deploy (for example, using GitHub releases).
Migration files live under electron/migrations, and follow the
TIMESTAMP-MigrationName.ts naming convention. You can use the Node.js REPL
to generate timestamps:
Welcome to Node.js v12.18.2.
Type ".help" for more information.
> Date.now();
1595165573664