Made possible by this template repo for eframe.
The official egui docs are at https://docs.rs/egui. If you prefer watching a video introduction, check out https://www.youtube.com/watch?v=NtUkr_z7l84. For inspiration, check out the the egui web demo and follow the links in it to its source code.
The first time you cloned the repo, ask the pub GPG key from @jaques-sam and import it using gpg --import <KEY_FILENAME>. Then decrypt the secure file(s) with git-crypt unlock executed in the repo.
Make sure you are using the latest version of stable rust by running rustup update.
cargo run --release --bin prono-app
Install necessary cargo tools:
Use binstall: curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
Cargo tools: cargo binstall cargo-nextest grcov --secure
On Linux you need to first run:
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
On Fedora Rawhide you need to run:
dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel
You can compile your app to WASM and publish it as a web page.
We use Trunk to build for web target.
- Install the required target with
rustup target add wasm32-unknown-unknown. - Install Trunk with
cargo install --locked trunk. - Run
trunk serveto build and serve onhttp://127.0.0.1:8080. Trunk will rebuild automatically if you edit the project. - Open
http://127.0.0.1:8080/index.html#devin a browser. See the warning below.
assets/sw.jsscript will try to cache our app, and loads the cached version when it cannot connect to server allowing your app to work offline (like PWA). appending#devtoindex.htmlwill skip this caching, allowing us to load the latest builds during development.
- Just run
trunk build --release. - It will generate a
distdirectory as a "static html" website - Upload the
distdirectory to any of the numerous free hosting websites including GitHub Pages. - we already provide a workflow that auto-deploys our app to GitHub pages if you enable it. See contribution doc.
As of 2023, egui is in active development with frequent releases with breaking changes.
When updating egui and eframe it is recommended you do so one version at the time, and read about the changes in the egui changelog and eframe changelog.