forked from SamouraiDev/AnonWork
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
add architecture
- Loading branch information
Showing
6 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Whirlpool architecture | ||
|
||
|
||
## I. Usage | ||
Whirlpool can be managed: | ||
- from desktop: `whirlpool-gui` | ||
- from REST API for developers: `whirlpool-cli API` | ||
- from command line: `whirlpool-cli` | ||
|
||
![](charts/usage.png) | ||
|
||
|
||
## II. Modules | ||
Whirlpool is modular: | ||
- 4 java modules: `server`, `client`, `protocol`, `cli` | ||
- 1 electron/react module: `GUI` | ||
|
||
`client` and `server` communicate through `protocol`. | ||
|
||
![](charts/architecture.png) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
graph TD | ||
|
||
classDef ext fill:#faf9f9,stroke:#888,stroke-width:2px; | ||
|
||
GUI[Whirlpool-GUI] -->|rest CLI api|CLI[Whirlpool-CLI] | ||
CLI -->CLIENT[Whirlpool-client] | ||
|
||
CLIENT -->|websocket + rest|PROTOCOL{Whirlpool-protocol} | ||
|
||
SERVER[Whirlpool-server] -->|websocket + rest|PROTOCOL | ||
|
||
class DOJO ext |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Charts are generated from Markdown | ||
using https://mermaidjs.github.io/mermaid-live-editor/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
graph TD | ||
|
||
classDef blue fill:#faf9f9,stroke:#888,stroke-width:2px; | ||
|
||
DSK(Desktop)-->GUI | ||
GUI[Whirlpool-gui] -->CLIAPI{cli-api} | ||
DEV(Third-party software)-->CLIAPI | ||
|
||
CLIAPI -->|rest|CLI[Whirlpool-cli] | ||
CMD(Command-line)-->|java -jar|CLI | ||
|
||
CLI-->CLIENT[Whirlpool-client] | ||
WALLET(Android)-->CLIENT | ||
class DSK,DEV,CMD,WALLET blue |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.