Use trunk for web demo (#38)

* Linked to #27

.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.wasm32-unknown-unknown]
+rustflags = ["--cfg=web_sys_unstable_apis"]

.github/workflows/pages.yml

@@ -0,0 +1,48 @@
+name: Github Pages
+
+# By default, runs if you push to main. keeps your deployed app in sync with main branch.
+on:
+  push:
+    branches:
+      - main
+# to only run when you do a new github release, comment out above part and uncomment the below trigger.
+# on:
+#   release:
+#     types:
+#       - published
+
+permissions:
+  contents: write # for committing to gh-pages branch.
+
+jobs:
+  build-github-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2 # repo checkout
+      - uses: actions-rs/toolchain@v1 # get rust toolchain for wasm
+        with:
+          profile: minimal
+          toolchain: stable
+          target: wasm32-unknown-unknown
+          override: true
+      - name: Rust Cache # cache the rust build artefacts
+        uses: Swatinem/rust-cache@v1
+      - name: Download and install Trunk binary
+        run: wget -qO- https://github.com/thedodd/trunk/releases/latest/download/trunk-x86_64-unknown-linux-gnu.tar.gz | tar -xzf-
+      - name: Build # build
+        # Environment $public_url resolves to the github project page.
+        # If using a user/organization page, remove the `${{ github.event.repository.name }}` part.
+        # using --public-url something will allow trunk to modify all the href paths like from favicon.ico to repo_name/favicon.ico .
+        # this is necessary for github pages where the site is deployed to username.github.io/repo_name and all files must be requested
+        # relatively as eframe_template/favicon.ico. if we skip public-url option, the href paths will instead request username.github.io/favicon.ico which
+        # will obviously return error 404 not found.
+        run: cd example_app && ../trunk build --release --public-url $public_url  --dist ../dist/
+        env:
+          public_url: "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}"
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: dist
+          # this option will not maintain any history of your previous pages deployment
+          # set to false if you want all page build to be committed to your gh-pages branch history
+          single-commit: true

.github/workflows/rust.yml

@@ -134,3 +134,22 @@ jobs:
         rust-version: "1.76.0"
         log-level: warn
         command: check
+
+
+  trunk:
+    name: trunk
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: 1.76.0
+          target: wasm32-unknown-unknown
+          override: true
+      - name: Download and install Trunk binary
+        run: wget -qO- https://github.com/thedodd/trunk/releases/latest/download/trunk-x86_64-unknown-linux-gnu.tar.gz | tar -xzf-
+      - name: Build
+        run: cd example_app && ../trunk build --release --public-url $public_url  --dist ../dist/
+        env:
+          public_url: "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}"

.gitignore

@@ -6,5 +6,7 @@ target
 target_ra
 target_wasm
 
+dist/
+
 # https://github.com/lycheeverse/lychee
 .lycheecache

README.md

@@ -13,27 +13,30 @@ This is a simple [WebSocket](https://en.wikipedia.org/wiki/WebSocket) library fo
 ## Usage
 
 ``` rust
-let (mut sender, receiver) = ewebsock::connect("ws://example.com").unwrap();
+let options = ewebsock::Options::default();
+// see documentation for more options
+let (mut sender, receiver) = ewebsock::connect("ws://example.com", options).unwrap();
 sender.send(ewebsock::WsMessage::Text("Hello!".into()));
 while let Some(event) = receiver.try_recv() {
     println!("Received {:?}", event);
 }
 ```
 
 ## Testing
+
 First start the example echo server with:
+
 ```sh
 cargo r -p echo_server
 ```
 
-Then test the native library with:
+Then test the library with:
 
 ```sh
+# native mode
 cargo run -p example_app
-```
 
-And the web library with:
-```sh
-./example_app/start_server.sh &
-./example_app/build_web.sh --open
+# web mode
+# install trunk with `cargo install trunk` - https://trunkrs.dev/
+cd example_app/ && trunk serve
 ```

clippy.toml

@@ -59,7 +59,7 @@ disallowed-types = [
   # "std::sync::Once",  # enabled for now as the `log_once` macro uses it internally
 ]
 
-# Allow-list of words for markdown in dosctrings https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
+# Allow-list of words for markdown in docstrings https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
 doc-valid-idents = [
   # You must also update the same list in `scripts/clippy_wasm/clippy.toml`!
   "GitHub",