2. Getting Started

You can follow the instructions to get a copy of the project and run it on your local machine.

Prerequisites

It's necessary to have node (>9) and npm(>5) installed. (It has been tested with node 9.11.2 and npm 5.6.0)

• Node and NPM
• Node v9.11.2 and npm v5.6.0 for Windows

Check installed Versions

npm -v
node -v

Installing

Dependencies installation

Linux & Mac

npm install

Windows

Administration privileges may be required.

1. Install Python 3.7 (Versions above this are not supported). It is necessary to configure the Enviroment variables. If you check "Add Python 3.7 to PATH", go to Step 2.

   1. Open the Control Panel (easy way: click in the Windows search on your task bar, type Control Panel, then click the icon).
   2. In the Control Panel, search for Environment; click Edit the System Environment Variables. Then click the Environment Variables button.
   3. In the System Variables section, you will need to either edit an existing PATH variable. If you’re editing an existing PATH, the values are presented on separate lines in the edit dialog. Add your Python 3.7 path Example: C:\Python37.
   4. Open CMD and check python is installed with the command python --version.

2. Install node-gyp.

npm install -g node-gyp

3. Install node package for Windows (It takes a while, be patient).

npm install --global --production windows-build-tools 

4. Install project dependencies.

npm install 

How to run

npm run electron:serve

How to build

npm run electron:build