https://github.com/witnet/sheikah
A Witnet compatible desktop wallet and smart contracts development environment
https://github.com/witnet/sheikah
blockchain don electron hdwallet ide oracles smart-contracts witnet
Last synced: 10 months ago
JSON representation
A Witnet compatible desktop wallet and smart contracts development environment
- Host: GitHub
- URL: https://github.com/witnet/sheikah
- Owner: witnet
- License: gpl-3.0
- Created: 2018-02-04T18:18:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T16:13:25.000Z (over 1 year ago)
- Last Synced: 2025-05-07T18:56:53.386Z (about 1 year ago)
- Topics: blockchain, don, electron, hdwallet, ide, oracles, smart-contracts, witnet
- Language: Vue
- Homepage: https://witnet.io
- Size: 18.1 MB
- Stars: 36
- Watchers: 12
- Forks: 23
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Installation
### Dependencies
At this time, you have to install the following dependencies to run sheikah:
- `openssl`
### From Github Releases
Go to [releases](https://github.com/witnet/sheikah/releases) section and download the binary suitable for your system.
## Sheikah Development
This is a Web/Desktop application built with [Electron](https://electronjs.org/). 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.
### Running Sheikah
```bash
# clone the repository
git clone git@github.com:witnet/sheikah.git
# cd into the cloned repository
cd sheikah
# install application dependencies
pnpm install
# launch development application
pnpm dev
```
### Formatter
- Verify files are correctly formatted with `pnpm lint:check`
- Repair lint errors with (**this operation modifies your files!**) `pnpm lint`
### Test
We use [Jest](https://facebook.github.io/jest/) for testing.
```bash
# run unit tests
pnpm test
```
### Build
#### Production
To build the application run: `pnpm build`, the build files are written to `dist_electron` directory.
### Contributing
You can read the [contributing guide](https://github.com/witnet/sheikah/blob/master/.github/CONTRIBUTING.md)
#### Github Actions (continuous integration)
When opening a pull request a job in [Github Actions](https://github.com/features/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.
#### Troubleshooting
- Use `pnpm clean` to remove the contents of the build directory (`dist_electron`)
- Use `pnpm clean-deps` to remove all installed dependencies
- Use `pnpm reinstall` to 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.
## Release
Releases are created using [action-electron-builder](https://github.com/samuelmeuli/action-electron-builder). A new draft release will be publish naming a commit and a tag as v*.*.\*
