An open API service indexing awesome lists of open source software.

https://github.com/inokawa/rust-wasm-gol

A Conway's Game of Life implementation with WebAssembly generated by Rust.
https://github.com/inokawa/rust-wasm-gol

Last synced: 6 months ago
JSON representation

A Conway's Game of Life implementation with WebAssembly generated by Rust.

Awesome Lists containing this project

README

          

# rust-wasm-gol

![deploy](https://github.com/inokawa/rust-wasm-gol/workflows/deploy/badge.svg)

A Conway's Game of Life implementation with WebAssembly generated by Rust.

Following the tutorial:

- https://rustwasm.github.io/docs/book/
- https://github.com/rustwasm/wasm_game_of_life

## Demo

https://inokawa.github.io/rust-wasm-gol/

## How to install

```sh
npm install
```

## How to run in debug mode

```sh
# Builds the project and opens it in a new browser tab. Auto-reloads when the project changes.
npm start
```

## How to build in release mode

```sh
# Builds the project and places it into the `dist` folder.
npm run build
```

## How to run unit tests

```sh
# Runs tests in Firefox
npm test -- --firefox

# Runs tests in Chrome
npm test -- --chrome

# Runs tests in Safari
npm test -- --safari
```

## What does each file do?

- `Cargo.toml` contains the standard Rust metadata. You put your Rust dependencies in here. You must change this file with your details (name, description, version, authors, categories)

- `package.json` contains the standard npm metadata. You put your JavaScript dependencies in here. You must change this file with your details (author, name, version)

- `webpack.config.js` contains the Webpack configuration. You shouldn't need to change this, unless you have very special needs.

- The `js` folder contains your JavaScript code (`index.js` is used to hook everything into Webpack, you don't need to change it).

- The `src` folder contains your Rust code.

- The `static` folder contains any files that you want copied as-is into the final build. It contains an `index.html` file which loads the `index.js` file.

- The `tests` folder contains your Rust unit tests.