This is a template repo for eframe, a framework for writing apps using egui.
The goal is for this to be the simplest way to get started writing a GUI app in Rust.
You can compile your app natively or for the web, and share it using Github Pages.
Start by clicking "Use this template" at https://github.com/emilk/eframe_template/ or follow these instructions.
src/app.rs contains a simple example app. This is just to give some inspiration - most of it can be removed if you like.
Make sure you are using the latest version of stable rust by running rustup update
cargo run --release
On Linux you need to first run:
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev
On Fedora Rawhide you need to run:
dnf install clang clang-devel clang-tools-extra speech-dispatcher-devel libxkbcommon-devel pkg-config openssl-devel
You can compile your app to WASM and publish it as a web page. For this you need to set up some tools. There are a few simple scripts that help you with this:
./setup_web.sh
./build_web.sh
./start_server.sh
open http://127.0.0.1:8080/setup_web.shinstalls the tools required to build for webbuild_web.shcompiles your code to wasm and puts it in thedocs/folder (see below)start_server.shstarts a local HTTP server so you can test before you publish- Open http://127.0.0.1:8080/ in a web browser to view
The finished web app is found in the docs/ folder (this is so that you can easily share it with GitHub Pages). It consists of three files:
index.html: A few lines of HTML, CSS and JS that loads your app. You need to edit this (once) to replaceeframe_templatewith the name of your crate!your_crate_bg.wasm: What the Rust code compiles to.your_crate.js: Auto-generated binding between Rust and JS.
You can test the template app at https://emilk.github.io/eframe_template/.
As of 2021, egui is in active development with frequent releases with breaking changes. eframe_template will be updated in lock-step to always use the latest version of egui.