From 600fa41c1c085dda00fa2dd17738705c8cc2d53d Mon Sep 17 00:00:00 2001 From: Benedikt Terhechte Date: Sat, 18 Dec 2021 14:41:02 +0100 Subject: [PATCH] Added documentation --- postsack-web/Readme.md | 31 +++++++++++++++++++++++++++++++ postsack-web/fake_data/Readme.md | 13 +++++++++++++ postsack-web/web_demo/index.html | 4 ++-- 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 postsack-web/Readme.md create mode 100644 postsack-web/fake_data/Readme.md diff --git a/postsack-web/Readme.md b/postsack-web/Readme.md new file mode 100644 index 0000000..06366ce --- /dev/null +++ b/postsack-web/Readme.md @@ -0,0 +1,31 @@ +# Postsack Web + +This is the WASM / Web version of Postsack. It uses fake email data to provide a web demo +so that interested parties can try out Postsack native / the app without having to install +it on their device. + +## Building Postsack Web + +First, you need to make sure all dependencies are installed: + +``` sh +cd postsack-web +./setup_web.sh +``` + +Once this is done, building can be performed with a single script: + +``` sh +./build_web.sh +``` + +## Testing + +In order to simplify testing, `build_web.sh` will launch a browser on `localhost:8080`. +By default, `setup_web.sh` will install the `basic-http-server` so that you can run it +in the `web_demo` folder prior to running `build-web.sh`: + +``` sh +cd web_demo +basic-http-server -a 127.0.0.1:8080 . +``` diff --git a/postsack-web/fake_data/Readme.md b/postsack-web/fake_data/Readme.md new file mode 100644 index 0000000..6c97c0b --- /dev/null +++ b/postsack-web/fake_data/Readme.md @@ -0,0 +1,13 @@ +# Generate Data + +This folder contains generated fake data from [https://generatedata.com/generator](https://generatedata.com/generator). + +This data is used to generate `../src/generated.rs` so that the WASM build is compiled with data to be +used in the web demo. + +`generated.rs` can be rebuild via the following command: + +``` sh +cd fake_data # make sure you're in this folder +python ./generate.py +``` diff --git a/postsack-web/web_demo/index.html b/postsack-web/web_demo/index.html index c8ca381..822f77c 100644 --- a/postsack-web/web_demo/index.html +++ b/postsack-web/web_demo/index.html @@ -6,7 +6,7 @@ - egui – An experimental immediate mode GUI written in Rust + Postsack Web