ghost-portal/packages/apps-electron/README.md
Ivan Rukhavets 06e6c318fa
Update README.md for electron apps (#3362)
* Update README.md

* Add info on Electron app to the top-level README.

Co-authored-by: Krzysztof Jelski <krzysztof@ethworks.io>
2020-08-07 13:28:28 +02:00

18 lines
764 B
Markdown

# @polkadot/apps-electron
Desktop Polkadot apps client for Windows, Mac and Linux.
## Installation
[Download here](https://github.com/polkadot-js/apps/releases/latest) latest versions for Windows, Mac and Linux.
## Development and testing
Contributions are welcome!
Follow steps described [here](https://github.com/polkadot-js/apps#development) to setup the project.
* Run `yarn start:electron` to start the app in development mode. You will possibly see the `Not Found / 404` message. It's ok, just wait for the build to finish and refresh pressing `Ctrl+R`.
* Run `yarn test` to run tests
* Run `yarn packElectron:(mac|linux|windows)` with the OS you want to build for to create the app executable. Find the packages in `packages/apps-electron/release`.