Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 1.51 KB

setup.md

File metadata and controls

66 lines (47 loc) · 1.51 KB
Raw

Setup your environment

1. Prerequisites

Follow the Building batchlabs yourself instruction of the main readme in order to install all require dependencies.

Use yarn install instead of npm install. This ensures a consistent build environment with the right set of dependencies Migrating from npm to yarn

Start the dev server

npm run dev-server

Start electron

# In the command line
npm run dev-electron

# In VSCode just press F5

The dev-server and dev-electron support hot reload for a better development experience. Simply saving a file will cause the UI to refresh to your updated changes.

Note: Changes to any files in the node client directory ('src/client') require restarting the application.

Please also take a look at the coding guidelines for this repo for best practices.

Editor

If you're using VSCode (recommended) we suggest you use the following extensions:

  • EditorConfig for VS Code(Important)
  • TSLint
  • Debugger for Chrome

Detailed commands:

Magic command (starts the server and electron in dev mode)

npm run dev

Build project

npm run build

Run app

npm run electron

Run watch (this will build files on save)

npm run watch

Run dev server (this will handle the refresh of files and later should have live reload)

npm run dev-server

Run dev electron (to use the dev server you need to run this)

npm run dev-electron