|
4 | 4 |
|
5 | 5 | The Async DataFlow component aims to deliver asynchronous responses in real time to client applications, thus enabling end-to-end asynchronois flows without losing the ability to respond in real time or eventually, send data to client applications as a result of asynchronous operations and oriented to `messages / commands / events` on the platform. |
6 | 6 |
|
| 7 | +## Documentation |
7 | 8 |
|
8 | | -## Repository |
9 | | - |
10 | | -- [Channel Sender](https://github.com/bancolombia/async-dataflow/tree/master/channel-sender) Distributed Elixir Cluster implementation of real time with websockets and notifications channels. |
11 | | - |
12 | | -```mermaid |
13 | | - C4Dynamic |
14 | | - Boundary(aa, "Client side applications") { |
15 | | - Component(cli, "Single Page Application or Mobile App", "Javascript / Angular /Flutter", "") |
16 | | - } |
17 | | -
|
18 | | - Boundary(xx, "ADF") { |
19 | | - Component(sender, "Channel Sender", "", "") |
20 | | - } |
21 | | -
|
22 | | - Boundary(zz, "Backend") { |
23 | | - Component(abl, "Async business logic") |
24 | | - } |
25 | | -
|
26 | | - Rel(cli, sender, "create connection") |
27 | | - Rel(cli, abl, "Call Http or another entry point definition") |
28 | | - Rel(abl, cli, "Return Http Empty response") |
29 | | - Rel(abl, sender, "Send Response (Http)") |
30 | | - Rel(sender, cli, "Send Response (websocket)") |
31 | | -
|
32 | | - UpdateElementStyle(sender, $fontColor="black", $bgColor="orange", $borderColor="black") |
33 | | -
|
34 | | - UpdateRelStyle(cli, sender, $offsetX="-40", $offsetY="-20") |
35 | | - UpdateRelStyle(cli, abl, $offsetX="-240", $offsetY="-40") |
36 | | - UpdateRelStyle(abl, cli, $offsetX="30", $offsetY="-40") |
37 | | - UpdateRelStyle(abl, sender, $offsetX="-60", $offsetY="40") |
38 | | - UpdateRelStyle(sender, cli, $offsetX="-40", $offsetY="20") |
39 | | - |
40 | | - UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="2") |
41 | | -``` |
42 | | - |
43 | | - |
44 | | -- [Channel Streams](https://github.com/bancolombia/async-dataflow/tree/master/channel-streams) Distributed Elixir Cluster implementation of a async messages router. |
45 | | - |
46 | | -```mermaid |
47 | | - C4Dynamic |
48 | | -
|
49 | | - Boundary(zz, "Backend") { |
50 | | - Component(abl, "Async business logic") |
51 | | - SystemDb(bus, "Event bus") |
52 | | - } |
53 | | - |
54 | | - Boundary(xx, "ADF") { |
55 | | - Component(sender, "Channel Sender", "", "") |
56 | | - Component(streams, "Channel Streams", "", "") |
57 | | - } |
58 | | -
|
59 | | - Boundary(aa, "Client side applications") { |
60 | | - Component(cli, "Single Page Application or Mobile App", "Javascript / Angular /Flutter", "") |
61 | | - } |
62 | | -
|
63 | | - Rel(abl, bus, "Emit event") |
64 | | - Rel(bus, streams, "Subscribe event") |
65 | | - Rel(streams, sender, "route [Http]") |
66 | | - Rel(sender, cli, "Push response [websocket]") |
67 | | -
|
68 | | - UpdateElementStyle(sender, $fontColor="black", $bgColor="orange", $borderColor="black") |
69 | | - UpdateElementStyle(streams, $fontColor="black", $bgColor="green", $borderColor="black") |
70 | | -
|
71 | | - UpdateRelStyle(abl, bus, $offsetX="-40", $offsetY="-40") |
72 | | - UpdateRelStyle(bus, streams, $offsetX="-40", $offsetY="-20") |
73 | | - UpdateRelStyle(streams, sender, $offsetX="-33", $offsetY="-20") |
74 | | - UpdateRelStyle(sender, cli, $offsetX="-40", $offsetY="-10") |
75 | | - |
76 | | - UpdateLayoutConfig($c4ShapeInRow="2", $c4BoundaryInRow="1") |
77 | | -``` |
78 | | - |
79 | | - |
80 | | -- [Client JS](https://github.com/bancolombia/async-dataflow/tree/master/clients/client-js) Javascript library for async data flow implementation for browsers. |
81 | | -- [Client Dart](https://github.com/bancolombia/async-dataflow/tree/master/clients/client-dart) Dart library for async data flow implementation for flutter applications. |
82 | | - |
83 | | -- [Examples](https://github.com/bancolombia/async-dataflow/tree/master/examples) |
84 | | - The purpose of this project is to help the community to understand more the the async data flow component to implement in full asyncio solutions. |
85 | | - |
86 | | -## How can I help? |
87 | | - |
88 | | -Review the [issues](https://github.com/bancolombia/async-dataflow/issues). Read [how Contributing](https://github.com/bancolombia/async-dataflow/wiki/Contributing). |
| 9 | +The documentation for this component is available in the [Async DataFlow Documentation Site](https://bancolombia.github.io/async-dataflow/). |
0 commit comments