etcher/docs/RUNNING-LOCALLY.md
Juan Cruz Viotti 66a810e764 chore: apply HFS+ compression to *.app in OS X (#715)
This results in ~10MB savings, which is not much, but still worth
reducing as much as we can.

See: https://github.com/resin-io/etcher/issues/711
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
2016-09-23 14:11:42 -04:00

1.6 KiB

Running locally

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

Prerequisites

Common

Windows

OS X

Cloning the project

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

Installing dependencies

Please make use of the following scripts to install 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.

OS X

./scripts/build/darwin.sh install

GNU/Linux

./scripts/build/linux.sh install <x64|x86>

Windows

Run the following command from the Developer Command Prompt for VS2013, to ensure all Visual Studio command utilities are available in the %PATH%:

.\scripts\build\windows.bat install <x64|x86>

Running the application

GUI

npm start

CLI

node bin/etcher