etcher/docs/RUNNING-LOCALLY.md
Juan Cruz Viotti 0aefa56e1d chore: make asar a development dependency (#1330)
To prevent any potential version incompatibility caused by simply installing
the latest version of the packages in the CI services.

See: https://github.com/resin-io/etcher/pull/1326
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
2017-04-20 13:48:31 -04:00

2.3 KiB

Running locally

This document aims to serve as a guide to get Etcher running locally on your development machine.

Prerequisites

Common

Windows

The following MinGW packages are required:

  • msys-make
  • msys-unzip
  • msys-zip
  • msys-bash
  • msys-coreutils

OS X

Cloning the project

git clone https://github.com/resin-io/etcher
cd etcher

Installing npm dependencies

Make sure you have all the pre-requisites listed above installed in your system before running the install script.

Please make use of the following scripts to install npm dependencies rather than simply running npm install given that we need to do extra configuration to make sure native dependencies are correctly compiled for Electron, otherwise the application might not run successfully.

If you're on Windows, run the command from the Developer Command Prompt for VS2015, to ensure all Visual Studio command utilities are available in the %PATH%.

make electron-develop

Running the application

GUI

npm start

CLI

node bin/etcher