Skip to content

Commit 06e6c31

Browse files
vanruchKrzysztof Jelski
and
Krzysztof Jelski
authored
Update README.md for electron apps (polkadot-js#3362)
* Update README.md * Add info on Electron app to the top-level README. Co-authored-by: Krzysztof Jelski <krzysztof@ethworks.io>
1 parent 4e38f0d commit 06e6c31

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,18 @@ QmfGBgFe2aqf83Wv21m9k5DH2ew89CDj4tydoxJWdK6NNL 1552 runtime.3d77e510.js
148148
QmYPa8jcHH7gfopMALr5XTW4i1QM2xgVBe3NeP11y3tErA - static/
149149
QmeYBC5EgbccC8NEwXC2rvbd93YiHtTM5xYzqCDohXerDf 859984 vendor.8b793a81.js
150150
```
151+
152+
## Desktop App
153+
154+
The main advantage of using Desktop App is that it by default stores encrypted accounts on the filesystem instead of browser's local storage.
155+
Local storage is susceptible to attacks using XSS (Cross-Site Scripting). There's no such risk when with files stored on disk.
156+
157+
The desktop app uses the [Electron](https://www.electronjs.org/) framework. It provides the same features as web app, the only difference
158+
being different account storage.
159+
160+
The accounts are stored in the following directories:
161+
* Mac: `~/Library/Application Support/polkadot-apps/polkadot-accounts`
162+
* Linux: `~/.config/polkadot-apps/polkadot-accounts` (or `$XDG_CONFIG_HOME/polkadot-apps/polkadot-accounts` if `$XDG_CONFIG_HOME` is defined)
163+
* Windows: `%APPDATA%\polkadot-apps\polkadot-accounts`
164+
165+
For more details on the desktop app, head over to [Electron package README](https://github.com/polkadot-js/apps/blob/master/packages/apps-electron/README.md).

packages/apps-electron/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# @polkadot/apps-electron
22

3-
WARNING: This is not deemed stable yet for external use.
3+
Desktop Polkadot apps client for Windows, Mac and Linux.
4+
5+
## Installation
6+
7+
[Download here](https://github.com/polkadot-js/apps/releases/latest) latest versions for Windows, Mac and Linux.
8+
9+
## Development and testing
10+
11+
Contributions are welcome!
12+
13+
Follow steps described [here](https://github.com/polkadot-js/apps#development) to setup the project.
14+
15+
* 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`.
16+
* Run `yarn test` to run tests
17+
* 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`.

0 commit comments

Comments
 (0)