Skip to content

Latest commit

Β 

History

History
81 lines (52 loc) Β· 2.88 KB

README.md

File metadata and controls

81 lines (52 loc) Β· 2.88 KB

πŸ¦€πŸ•Έ Rust-WASM Todo List

About

πŸ“š Read this template tutorial! πŸ“š

This project is a simple Todo List application built using Rust and WebAssembly (WASM). It's one of the more unusual projects I've ever worked on, showcasing the power of Rust and WASM in a web application.

Be sure to check out other wasm-pack tutorials online for other templates and usages of wasm-pack.

πŸ“‹ Table of Contents

🚴 Usage

πŸ‘ Use cargo generate to Clone this Template

Learn more about cargo generate here.

cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
cd my-project

πŸ› οΈ Build with wasm-pack build

wasm-pack build

πŸ”¬ Test in Headless Browsers with wasm-pack test

wasm-pack test --headless --firefox

🎁 Publish to NPM with wasm-pack publish

wasm-pack publish

πŸ”‹ Batteries Included

  • wasm-bindgen for communicating between WebAssembly and JavaScript.
  • console_error_panic_hook for logging panic messages to the developer console.
  • LICENSE-APACHE and LICENSE-MIT: most Rust projects are licensed this way, so these are included for you.

πŸ“ License

This project is licensed under either of

at your option.

🀝 Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


This README provides a clear structure, helpful emojis, and all necessary information about the project, including sections for usage, building, testing, publishing, and contribution guidelines. It also includes placeholders for screenshots to visually represent your project.

Screenshot πŸ“Έ