Get Started

Purchasing a license

For development and building using RillRate Stack, you need a valid license.

If you don't have a license, you can purchase it on the http://rillrate.com site or send a request to support@rillrate.com email.

Access to sources

We will give you a membership in the github.com/rillrate organization with access to private repositories when you've got a license.

There are two private repositories available:

Suppose you have never used the framework before. In that case, the Examples project is a good option for beginners because it represents a recommended structure for using the framework and organizing the code.

Install requirements

git

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

You need Git tool to get sources of the framework.

cargo-make

https://github.com/sagiegurari/cargo-make

Cargo Make tools helps to organize complex building process. We use it for preparing assets.

trunk

https://trunkrs.dev/ or https://github.com/thedodd/trunk

Trunk is a tool for building WASM applications. It required to compile the rillrate-app, but you will also need it to create a customized front-end app.

Add the Stack to your project

If you have a project where you want to start to use the framework, you should include sources in the folder of your project. We will create a new project from scratch here to show you how to use it.

Prepare sources

Let's create a new Rust binary crate:

cargo new --bin my-project

Enter into the project's folder and add the framework as a submodule:

cd my-project
git submodule add git@github.com:rillrate/stack.git

It will add the stack folder with the sources of the framework.

Now enter the stack folder and run the command to build all necessary assets:

cd stack
cargo make build-release

The command above will build and prepare rillrate-app for use.

It's the default universal dashboard app includes a minimal set of necessary UI packs.

You should go to the project's root folder and add dependencies to your project.

Add dependencies

Add rillrate crate to the dependencies list of the Cargo.toml config of your project:

[package]
name = "my-project"
version = "0.1.0"
edition = "2021"

[dependencies]
anyhow = "1.0.53"
rillrate = { path = "stack/rillrate" }
tokio = "1.16.1"

We used a relative path to the stack folder and added two extra dependencies:

  • anyhow - for error handling
  • tokio - async runtime that used by the framework

Now we can start the engine.

Start the supervisor

To launch the engine, you should call install method of the rillrate crate:

use anyhow::Error;

#[tokio::main]
async fn main() -> Result<(), Error> {
    let (mut system, _supervisor) = rillrate::install()?;
    system.join().await;
    Ok(())
}

It returns links to a system and a supervisor that we can use to communicate with those instances.

The System is an actor runtime from the meio crate.

The second value of the returned tuple is the WayLink connected to the framework's supervisor actor and can be used to attach front-end assets or set a root layout.

Now you can run the app, and if you try to connect to the https://localhost:6361 with a browser, you will see the empty layout of the dashboard.

"Live Dashboard in 5 Minutes" weekly digest Subscribe