Development

To start developing on the project, you will first need to install rustup.

Rustup is an installer for the Rust language. It is the recommended way to install Rust, as it manages both the installation and updates of the Rust compiler and tools. It installs the Rust compiler (rustc) and the cargo package manager.

After installing rustup, you can install trunk with :

cargo install trunk

trunk allows you to build, bundle, and optimize your WebAssembly application.

Finally, you can clone the repository with :

git clone git@github.com:tramex/tramex.git

Development

To start the application, you can run the following command in the repository :

# for the web application
trunk serve

# for the desktop application
cargo run

Tips

To check the code style, you can run the following command :

cargo clippy

Debug mode

To run the application in debug mode, you can run the following command :

# this will activate the debug features in tramex and tramex-tools
cargo run --features debug

# more logs
RUST_BACKTRACE=1 RUST_LOG=debug cargo run --features debug