rillrate 0.41.0

Real-time UI for bots
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

## RillRate

### Real-time UI for bots, microservices, and IoT

RillRate is a library that embeds a live web dashboard to your app.

Fast, embedded, with auto-layout and controls. No configuration is needed.
**Support**: [Rust][rillrate-rs], [Python][rillrate-py]. _Soon_: Node.js, Java, C#.

<img align="center" width="400px" src="https://rillrate.com/images/home/dashboard.png" />

- **_It's fully custom_** - You add your own data streams with everything you want
- **_It works in real-time!_** - NOT `5 secs` real-time, it's `0.002 secs` real-time 🚀
- **_Zero-configuration_** - you don't need to install and configure any other software
- **_Web-dashboard included_** - add the library to your app and connect to the dashboard with a web browser
- **_Ferris-friendly_** - we created it using Rust only: from backed to UI 🦀

Become a [sponsor][sponsor] to see how the project is born.  Sponsors also get
access to sources of the UI dashboard that made with the [Yew][yew] Framework.

Join our [reddit/rillrate][reddit] community to stay tuned about all the new features we released every day!

Follow us on [Twitter][twitter] and watch or participate weekly competitions.

### How to use it?

Add a dependency to your `Cargo.toml`:

```toml
[dependencies]
rillrate = "0.41.0"
```

Install the **rillrate** engine in the `main` function:

```rust
rillrate::install("my-app");
```

And create a `Tracer` to visualize data on the embedded dashboard:

```rust
let my_tracer = Pulse::new(
    "package.dashboard.group.tracer-name",
    FlowMode::Realtime,
    PulseOpts::default().min(0).max(50).higher(true)
);
```

When you tracer is spawned use it to put data to it:

```rust
tracer.push(value);
```

### Packs

RillRate provides packs of components for different purposes.

Released:

- **Prime** - basic elements

In progress:

- **APM** - components for performance monitoring
- **Charts** - all basic charts
- **Trade** - live components for trading (order books, charts, etc.)

### Project structure

The project consists of the following parts:

- `pkg-core` (backend) - core components and the engine
- `pkg-dashboard` (frontend) - the dashboard app and rendering routines
- `pkg-packs` - tracers for different data stream types
- `rillrate` - the main library that joins all the parts above
- `demo` - the demo app

### Frameworks

We use the following frameworks to build our product:

- [Yew][yew] Framework (frontend)
- [meio][meio] actor framework (backend)

The original idea was inspired by [Nitrogen][nitrogen] Web Framework (Erlang).

<hr>

### License

**RillRate** is provided under the _Apache-2.0_ license. See [LICENSE](LICENSE).

The project is the Full-stack Rust app: both frontend and backend made with Rust.

[reddit]: https://reddit.com/r/rillrate/
[twitter]: https://twitter.com/rillrate/
[sponsor]: https://github.com/sponsors/rillrate
[nitrogen]: https://nitrogenproject.com/
[yew]: https://github.com/yewstack/yew
[meio]: https://github.com/rillrate/meio
[rillrate-rs]: https://github.com/rillrate/rillrate
[rillrate-py]: https://github.com/rillrate/rillrate-py