At this time, you have to install the following dependencies to run sheikah:
openssl
Go to releases section and download the binary suitable for your system.
This is a Web/Desktop application built with Electron. When developing Sheikah, we support Node CURRENT and LTS+. It might work with another version but we do not guarantee it will do in the future.
# clone the repository
git clone [email protected]:witnet/sheikah.git
# cd into the cloned repository
cd sheikah
# install application dependencies
pnpm install
# launch development application
pnpm dev- Verify files are correctly formatted with
pnpm lint:check - Repair lint errors with (this operation modifies your files!)
pnpm lint
We use Jest for testing.
# run unit tests
pnpm testTo build the application run: pnpm build, the build files are written to dist_electron directory.
You can read the contributing guide
When opening a pull request a job in Github Actions will be fired off to check the changes. To avoid wasting time waiting for Github Actions output we provide the command pnpm ci that will perform almost the same checks but it'll run in your computer.
- Use
pnpm cleanto remove the contents of the build directory (dist_electron) - Use
pnpm clean-depsto remove all installed dependencies - Use
pnpm reinstallto remove all installed dependencies and install them again
If the application doesn't boot correctly and no error is reported in the terminal, try running pnpm reinstall and try again.
Releases are created using action-electron-builder. A new draft release will be publish naming a commit and a tag as v*.*.*