You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-31Lines changed: 34 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@
10
10
11
11
> Electron Desktop app that helps you easily spin up and manage Swarm's Bee node
12
12
13
-
**Warning: Swarm Desktop is in Beta and currently includes the [Sentry](https://sentry.io/welcome/) application monitoring and bug reporting software which automatically collects data in order to help improve the software.**
13
+
**Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and
14
+
working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
14
15
15
-
**Warning: This project is in beta state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
16
-
17
-
Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/swarm-desktop/releases).
16
+
Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the
@@ -27,17 +27,17 @@ Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6)
27
27
28
28
## Install
29
29
30
-
Go to the [releases page](https://github.com/ethersphere/swarm-desktop/releases/latest) and download the correct build for your operation system:
31
-
32
-
- Windows: `Swarm.Desktop-***.Setup.exe`
33
-
- macOS: `Swarm.Desktop-darwin-x64-***.zip`
34
-
- Linux: `swarm-desktop_***_amd64.deb` or `swarm-desktop-***-1.x86_64.rpm`
30
+
Go to the [releases page](https://github.com/ethersphere/swarm-desktop/releases/latest) and download the correct build
31
+
for your operation system:
35
32
36
-
> Until 1.0 release, all our developer releases has automatically enabled error tracking and reporting using sentry.io which is not possible to opt-out!
33
+
- Windows: `Swarm.Desktop-***.Setup.exe`
34
+
- macOS: `Swarm.Desktop-darwin-x64-***.zip`
35
+
- Linux: `swarm-desktop_***_amd64.deb` or `swarm-desktop-***-1.x86_64.rpm`
37
36
38
37
### macOS
39
38
40
-
macOS may not allow you to run the .app after unzipping. To solve this, right click the .app and click Open. You will have an option to ignore the warning.
39
+
macOS may not allow you to run the .app after unzipping. To solve this, right click the .app and click Open. You will
40
+
have an option to ignore the warning.
41
41
42
42
## Usage
43
43
@@ -49,57 +49,60 @@ There are some ways you can make this module better:
49
49
50
50
- Consult our [open issues](https://github.com/ethersphere/swarm-desktop/issues) and take on one of them
51
51
- Help our tests reach 100% coverage!
52
-
- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or want to give feedback
52
+
- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or
53
+
want to give feedback
53
54
54
55
### Architecture
55
56
56
57
Swarm Desktop consists of two components:
57
58
58
-
1. Electron back-end that provides orchestration API that retrieve, spins, stops and manage the Bee node
59
-
2. Bundled [Bee Dashboard](https://github.com/ethersphere/bee-dashboard) that provides UI to manage Bee node and provides access to Swarm network
59
+
1. Electron back-end that provides orchestration API that retrieve, spins, stops and manage the Bee node
60
+
2. Bundled [Bee Dashboard](https://github.com/ethersphere/bee-dashboard) that provides UI to manage Bee node and
61
+
provides access to Swarm network
60
62
61
63
The Electron back-end is placed in `src` folder.
62
64
63
65
The Bee Desktop stores logs of both itself and Bee in the application's logs folder:
64
66
65
-
- macOS: `~/Library/Logs/Swarm Desktop/`
66
-
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Log\` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Log\`)
67
-
- Linux: `~/.local/state/Swarm Desktop/`
67
+
- macOS: `~/Library/Logs/Swarm Desktop/`
68
+
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Log\` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Log\`)
69
+
- Linux: `~/.local/state/Swarm Desktop/`
68
70
69
71
It also stores configuration files, Bee assets and other things in application's data folder:
70
72
71
-
- Windows: `%LOCALAPPDATA%\Swarm Desktop\Data` (for example, `C:\Users\USERNAME\AppData\Local\Swarm Desktop\Data`)
72
-
- Mac OS: `~/Library/Application Support/Swarm Desktop`
As there are several independent components it bit depends on what you want to develop.
78
80
79
-
**Be aware!** The UI won't automatically open during development in order not to confuse on which
80
-
environment they are running. You have to open them manually.
81
+
**Be aware!** The UI won't automatically open during development in order not to confuse on which environment they are
82
+
running. You have to open them manually.
81
83
82
84
#### Electron Desktop
83
85
84
86
To work on the Electron Desktop back-end you just need to do your work and then run `npm start`. This will launch the
85
-
Electron app and shows the Tray icon. No UI will be opened automatically. If you need to make more adjustment you have to exit
86
-
the process with `SIGINT (CTRL+C)` and relaunch.
87
+
Electron app and shows the Tray icon. No UI will be opened automatically. If you need to make more adjustment you have
88
+
to exit the process with `SIGINT (CTRL+C)` and relaunch.
87
89
88
90
#### UI (Dashboard)
89
91
90
-
To work on the Dashboard, run first `npm start` that will spin up the Electron Desktop back-end. Then go to your locally cloned `bee-dashboard` repo and
91
-
in it start the development server with `npm start`. Dashboard also needs to have API key injected in order to use the
92
-
Desktop's API. You can inject it by running `npm run desktop` in the Dashboard repo that will open the Dashboard UI with API key in the URL.
93
-
Changes are automatically hot-reloaded.
92
+
To work on the Dashboard, run first `npm start` that will spin up the Electron Desktop back-end. Then go to your locally
93
+
cloned `bee-dashboard` repo and in it start the development server with `npm start`. Dashboard also needs to have API
94
+
key injected in order to use the Desktop's API. You can inject it by running `npm run desktop` in the Dashboard repo
95
+
that will open the Dashboard UI with API key in the URL. Changes are automatically hot-reloaded.
94
96
95
-
The UI served by the Desktop itself is updated only when you update the `@ethersphere/bee-dashboard` NPM package in the Desktop repo.
97
+
The UI served by the Desktop itself is updated only when you update the `@ethersphere/bee-dashboard` NPM package in the
98
+
Desktop repo.
96
99
97
100
#### Maintenance tasks
98
101
99
102
There are several handy scripts:
100
103
101
-
-`npm run purge:data` that purge's the Desktop's data folder
102
-
-`npm run purge:logs` that purge's the Desktop's logs folder
104
+
-`npm run purge:data` that purge's the Desktop's data folder
105
+
-`npm run purge:logs` that purge's the Desktop's logs folder
0 commit comments