Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
add architecture
  • Loading branch information
zeroleak committed Jun 14, 2019
1 parent a8b57fb commit 28fe70a
Show file tree
Hide file tree
Showing 6 changed files with 49 additions and 0 deletions.
21 changes: 21 additions & 0 deletions ARCHITECTURE.md
@@ -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)

12 changes: 12 additions & 0 deletions charts/architecture.md
@@ -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
Binary file added charts/architecture.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions charts/charts.md
@@ -0,0 +1,2 @@
Charts are generated from Markdown
using https://mermaidjs.github.io/mermaid-live-editor/
14 changes: 14 additions & 0 deletions charts/usage.md
@@ -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
Binary file added charts/usage.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 28fe70a

Please sign in to comment.