Development Setup

Prerequisites

• sentientd
• sentient-miner
• node 10.16.3 & npm 6.9.0 LTS Earlier node versions may work, but they do not have guaranteed support.
• libxss is a required dependency for Electron on Debian, it can be installed with sudo apt-get install libxss1.

Running

Download your OS's release archive and unzip it

OR

Run from source

1. Install dependencies mentioned above
2. Download or git clone the repository
3. npm install
4. npm start

NOTE if you are running from source please specify path to sentientd and sentient-miner using these environment variables: SENTIENTD_PATH and SENTIENT_MINER_PATH.

Build new release

1. Bump version
2. Run commad APPLE_ID=<REDACTED> APPLE_PW=<REDACTED> npm run release. This command will upload all needed files to S3 bucket for auto-updating app.
3. From working directory ./sign.sh PRIVATE_KEY PUBLIC_KEY [UI_VERSION]. This command will create a signed archive for github release files.

Contributing

Read the document linked above to learn more about the application and its technologies.

Take a look at our issues page for a high level view of what objectives we're working on.

If you're the type to jump right into code, simply search through the project (sans the node_modules folder) for the term TODO:. If you're on a UNIX (Linux & OSX) system, run grep -r 'TODO:' js plugins in a terminal at the root level of the project