Ghost

Ghost is a BADASS Telemetry Monitor Application for Waseda Aeronautics and Space Associations's Human Powered Aircraft Project.

日本語README

Installation

//TODO

Contribution

Node.js must be installed for development.

- Setup

1. Open terminal for UNIX Systems or Command Prompt for Windows

2. Simply clone this repository to your computer. You may have to install git or GitHub Desktop. Since this is a private repository, you may also have to enter your GitHub username and password.

$ git clone https://github.com/MojamojaK/ghost.git

3. Install all packages.

$ npm install

4. If you are on Windows, install windows-build-tools to allow python use of npm. This enables rebuilding from source for the serialport module.

$ npm --add-python-to-path='true' --debug install --global windows-build-tools

5. Run rebuild command. This rebuilds all plaftorm native packages to become compatible to Electron.

$ npm run rebuild

6. You may now start and run the application with.

$ npm run

All codes should be implemented in the src directory.

Build resources such as application icons should be in the build directory.

- Building

Run the commands below for each platform.

Since codes are left unsigned, Operating Systems may initially reject installation.

Building Configurations should be in build-config.json . See electron-builder.

Built installers will be put in the dist directory

Windows

This will build a nsis installer for Windows 64bit.

Will only work on Windows. May work on Mac with wine installed, but is known to be unreliable.

$ npm run build_win

Mac

This will build a dmg image for MacOS. Works on all plaforms.

$ npm run build_mac

Linux

This will build an AppItem for Linux. Works on all plaforms.

$ npm run build_linux