irvanjitsingh / sttm-desktop

The SikhiToTheMax desktop app

SikhiToTheMax Desktop App

Prerequisites

1. Node
2. yarn
3. Github SSH Key Setup

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
• Run yarn rebuild to rebuild the native plugins for your system

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