https://github.com/smudger/walk-the-dog

The game from the Rust Games with WebAssembly book.
https://github.com/smudger/walk-the-dog

rust rust-lang rustlang wasm webassembly

Last synced: 21 days ago
JSON representation

The game from the Rust Games with WebAssembly book.

• Host: GitHub
• URL: https://github.com/smudger/walk-the-dog
• Owner: smudger
• Created: 2023-01-06T17:40:47.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-15T16:02:20.000Z (almost 2 years ago)
• Last Synced: 2024-11-24T23:21:51.650Z (28 days ago)
• Topics: rust, rust-lang, rustlang, wasm, webassembly
• Language: Rust
• Homepage: https://walk-the-dog-smudger.netlify.app/
• Size: 3.23 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Walk The Dog




![Build & Release](https://github.com/smudger/walk-the-dog/actions/workflows/build.yml/badge.svg?branch=main)

![Netlify Status](https://api.netlify.com/api/v1/badges/7135287c-8807-4aed-b528-78a8822573e5/deploy-status)

![npm version](https://badge.fury.io/js/@smudger%2Fwalk-the-dog.svg)



___

An endless runner about a boy walking his dog. The game from the Rust Games with WebAssembly book.

## Getting Started

```sh

npm install

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

npm run start

```

## Testing

```sh

# Run unit tests

cargo test

# Run integration tests

wasm-pack test --headless --firefox

# Run all tests

npm run test

```

## Releasing

1. Ensure `package.json` version is correct.

2. Create a tag with the desired version. This should match whatever is in `package.json`.

```sh

# e.g. git tag v0.3.2-alpha

git tag 

```

3. Push tag to GitHub repo. This will trigger a release to be created and the package to be released to the [NPM registry](https://npmjs.com).

```sh

# e.g. git push origin v0.3.2-alpha

git push origin 

```

4. Ensure the release notes are correct on the [GitHub repo](https://github.com/smudger/walk-the-dog/releases).

## Troubleshooting

If you are struggling to run the integration tests and use Firefox Developer Edition, you will need to add Firefox Developer Edition's firefox-bin to the path by running the following command.

```sh

export PATH="$PATH:/Applications/Firefox Developer Edition.app/Contents/MacOS"

```

This ensures that geckodriver is able to find a valid Firefox binary to use to run the tests.