Skip to content

development.md

Latest commit

 

History

History
116 lines (78 loc) · 3.14 KB

development.md

File metadata and controls

116 lines (78 loc) · 3.14 KB
Raw

Development setup

This is a guide to running the Infinity One desktop app from a source tree, in order to contribute to developing it.

Prerequisites

To build and run the app from source, you'll need the following:

  • Git
  • Node.js >= v6.9.0
    • NPM and node-gyp, if they don't come bundled with your Node.js installation
  • Python (v2.7.x recommended)
  • A C++ compiler compatible with C++11
  • Development headers for the libXext, libXtst, and libxkbfile libraries

Debian/Ubuntu and friends

On a system running Debian, Ubuntu, or another Debian-based Linux distribution, you can install all dependencies through the package manager (see here for more on the first command):

$ curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
$ sudo apt install git nodejs python build-essential libxext-dev libxtst-dev libxkbfile-dev libgconf-2-4

Fedora

You will need the following dependencies installed:

sudo dnf install g++ libXtst-devel libpng-devel

Snap

$ sudo dnf install snapd 
$ sudo ln -s /var/lib/snapd/snap /snap
$ sudo snap install snapcraft --classic

Other OSes

Other developers run the app on Windows, macOS, and possibly other OSes. PRs to add specific instructions to this doc are welcome!

On Windows, your C++ compiler should be Visual Studio 2015 or later.

Download, build, and run

Clone the source locally:

$ git clone https://github.com/infinityoneframework/infinityone-electron
$ cd infinityone-electron

Install project dependencies:

$ yarn

Start the app:

$ yarn vue-cli-service electron:serve

Troubleshooting

If you have any problems running the app, see the most common issues.

Publish a Release

GitHub Personal Access Token

Note: You will need a GitHub personal access token for this step. To get one, go to https://github.com/settings/tokens and click Generate new token.

In order for Electron Builder to upload a release to GitHub, you will need to make your token available by setting the GH_TOKEN env variable to your token:

On Linux/MacOS:

export GH_TOKEN=TOKEN-GOES-HERE

On Windows:

set GH_TOKEN=TOKEN-GOES-HERE

Upload Release to GitHub

Now that you have configured everything, tell electron-builder to upload your app to GitHub by running electron:build with the -p always argument:

With Yarn:

yarn electron:build -p always

or with NPM:

npm run electron:build -- -p always

This command will produce distributable packages or installers for the operating system you're running on:

  • on Windows, a Windows installer file
  • on macOS, a .dmg file
  • on Linux, a plain .zip file as well as a .deb file and an AppImage file. To generate all three types, you will need all three operating systems.

The output files appear in the dist/ directory.