Rust WASM Playground

A little project to play around with Rust and WebAssembly.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Notes
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

Most of the project is built with my CLI starter, so most of this README won't make a lot of sense. Installation instructions should work, though. This project is just a playground so I can mess around with early WASM in Rust.

(back to top)

Built With

• Rust
• wasm-pack
• pnpm

(back to top)

Getting Started

Using this template is pretty easy - just take a look at the prerequisites and installation steps below.

Prerequisites

• Rust
• pnpm
• wasm-pack

Installation

1. Clone the repo

   # with https
   git clone https://github.com/MylesWritesCode/rust-wasm.git
   
   # or ssh
   git clone [email protected]:MylesWritesCode/rust-wasm.git

2. Build WASM libraries

   wasm-pack build ./packages/metamorph
   

3. Install dependencies

   # install node dependencies
   pnpm install
   
   # install rust dependencies
   cargo build

Start the project

pnpm dev

(back to top)

Usage

1. Follow all the installation steps above

2. Build WASM libraries

   wasm-pack build ./packages/metamorph

3. Start the project (see above)

For more examples, please refer to the Documentation

(back to top)

Notes

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Myles Berueda

(back to top)