This project is based on eframe_template built in Rust targeting wasm to run in the browser.
This is my portfolio project. It is meant to highlight my job history and previous projects as well as be a project in and of itself to show off my programming abilities in an interesting and engaging way.
- Write a better readme
- Expand each set of windows into their own components (make
.rs
files for each 'page') - Make a stock / trading view component
- Make a pretty component with graphics and FFT generated audio for rain noises
- Make a mini-game component complete with audio and enjoyable (and simple) gameplay in 2d
- Chaos Equation viewer and editor (CodeParade)
src/app.rs
conatins the main page layout as you would expect in any web project written in Javascript for example.
assets/text_contents.toml
contains each widgets large text content. For example if you have a large EasyMark document
you don't want that stored in your .rs
file as that would bloat your code.
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 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 serve
to 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#dev
in a browser. See the warning below.
assets/sw.js
script 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#dev
toindex.html
will skip this caching, allowing us to load the latest builds during development.
- Just run
trunk build --release
. - It will generate a
dist
directory as a "static html" website - Upload the
dist
directory 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.
To enable Github Pages, you need to go to Repository -> Settings -> Pages -> Source -> set to
gh-pages
branch and/
(root).If
gh-pages
is not available inSource
, just create and push a branch calledgh-pages
and it should be available.
You can test the template app at https://emilk.github.io/eframe_template/.