Application Name

X is a cross platform application, built on Electron

Bootstrap

To get up and running

  script\bootstrap

Build

Builds can be generated easily via

  script\build

Builds are generated using the electron-packager combined with configuration from the config.json file. See the Configuration documentation for more details.

Development & Debugging

To run up the application

  script\server

To debug, there are two options

• Debugging render processes with the chrome dev tools
• Attach a node-inspector remote debugger. To debug the main process via the following helper scripts:

  script\server-debug

Node inspector can be quite slow to load. If you are looking to step through code at the beginning of the applications life cycle, it can be helpful to add a blocking wait on application start up.

Note: currently this is only supported in Electron v 0.27.1

Packaging

Application installation, and automatic updates are driven by Squirrel.

Windows

To create a Windows Squirrel installer run:

  script\package

This command should be run on a Windows machine.

OSX

TBC

Release

That 🚢 life!

Windows

To release the Squirrel installer:

  script\release

This uploads an installer to S3. You can provide access keys by adding a s3.key file to the root in the following format

AWSAccessKeyId=MYACCESSKEY
AWSSecretKey=SECRETKEY

s3.key is ignored in the .gitignore file. Please do not check in sensitive information such as s3 keys.

OSX

TBC