Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2.81 KB

README.md

File metadata and controls

90 lines (61 loc) · 2.81 KB
Raw

Wasm Warp Template

Wasm Warp Template is a minimal template to run rustwasm projects. The templete use yew as frontend with wasm and warp as server and watcher.

Note: You can replace yew framework with another framework based in rustwasm or just vanilla rustwasm

How it works

1.Replace the js file with the name of the project that you write in Cargo.toml in app/index.html

<script type="module">
    import init, { run } from './pkg/your_project_name.js'; //by default is wasm_warp_template.js

    const start = async() => {
    await init();
    run();
    };

    start();
</script>

If you need to include css file or another assets, it has to be inside of the static

<head>
    <link href="static/app.css" rel="stylesheet">
</head>

2.Run the template:

  • without logs: cargo run
  • with logs: RUST_LOG=name_of_your_project_from_Cargo.toml=trace cargo run

Note: By the default the name is wasm_warp_template

Ready to start developing 🚀

Customize running project

You can set the server address, the path where are the wasm sources and the env build in your .env file:

SERVER_ADRESS=[SERVER_ADDRESS]:[PORT] // by default is 127.0.0.1:8080
WASM_PATH=[PATH WHERE ARE YOUR WASM SOURCES] // by default is `app`
ENV_BUILD=production // skiping this variable will build in development mode without the optimization
EXCLUDING_PATHS="target pkg node_modules static Cargo.lock .vscode" //exclude files or direcotory from the watch. By default target pkg node_modules static Cargo.lock

Note: remember not include / in the end of the path and exclude all the files which are not utf-8 like images or binaries otherwise the watcher will crash

About WebSocket

To allow reload the browser when there are changes in the sources the server use WebSocket which is running in the port 3000. If you need change it you can do changing in these two files:

  1. app/index.html, line 24:
const reloadSocket = new WebSocket("ws://127.0.0.1:3000");
  1. src/main.rs, line 47
let websocket_srv = Server::bind(&([127, 0, 0, 1], 3000).into()).serve(make_websocket_svc);

Limitations

  • The watcher only can read utf-8 for now. It means that images or binaries for example will cause crash. This limitation will be resolved in spielrs-diff.

Roadmap

  • Fix watcher limitation
  • Customize watcher
  • Open a browser after start running the server
  • Avoid double reload after changes
  • Avoid duplicate message in sockect connection
  • Possibility to watch also not utf-8 files
  • Implement spielrs which will be based in parceljs but focus in rustwasm projects

License

Wasm Warp Template is MIT licensed. See license