SikhiToTheMax Desktop App

Prerequisites

1. Node - https://nodejs.org/en/download/
2. yarn - https://yarnpkg.com/en/docs/install
3. Have the Developer ID certificate for Khalis Foundation installed from Apple Developer Console
4. pageant on Windows for SSH access to remote server
5. AWS S3 keys
6. macOS

• Distribution provision profile in app root directory for Mac App Store

7. Windows

• Set CSC_LINK and CSC_KEY_PASSWORD environment variables with the .p12 path and decryption password respectively

Installation

• Clone repository
• Run git submodule update --init --recursive after you cd into the repository
• Run git checkout -t origin/dev in the repository root and the www folder
• Run yarn install in the repository root
• Depending on your current operating system, run yarn run pack:win or yarn run pack:mac to rebuild the native plugins for your system

Configuration

Uploading to Remote

Create file packaging/aws.json using packaging/aws-sample.json and fill out AWS information

Updating remote version file for downloading latest setup file

Create file packaging/keys.json using packaging/keys-sample.json and enter location of private key for SSH access to remote server where version number will be stored

Running

• Run yarn start in the repository root

Packaging

Create the app package for your system:

• macOS - Run yarn pack:osx
• Windows 64-bit - Run yarn pack:win
• Windows 32-bit - Run yarn pack:win32
• Linux/Ubuntu 64-bit - Run yarn pack:linux

Contributing

See CONTRIBUTING.md