Skip to content

Remnant: From the Ashes item checklist web app

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE_APACHE
MIT
LICENSE_MIT
Notifications You must be signed in to change notification settings

CoffeeAndCode/remnant-checklist

Repository files navigation

Remnant: From the Ashes Item Checklist

An offline enabled web app for tracking what items you've unlocked in Gunfire Games's Remnant: From the Ashes.

While the application is dual licensed MIT and Apache, all game related assets and content are © Gunfire Games, LLC.

The application is built with the Yew framework, which compiles Rust to WASM. It's built with wasm-pack and ❤️.

Data Out of Date?

Data for the application is stored in CSV files in the src/data/ directory. Please file a pull requests or an issue if you find issues with the data.

Development

While not all parts are necessarily needed, easy mode development requires:

If you're on a mac and have Homebrew installed, you can run brew install to install forego.

To start development, run forego start which will kick off the Procfile that:

  • watches files to automatically run tests
  • rebuilds the wasm file when tests pass
  • runs a local webserver using static files and Docker

Testing

Locally, you can run bin/lint.sh to lint the source files and bin/test.sh to run the Rust and WASM related tests.

The application is setup to run linters and tests in Github Actions.

Production

Running bin/build.sh creates a production release of static files in the public/ directory.

The application is hosted on Netlify and is setup to automatically publish CI builds that pass. It does not automatically take new builds live in production so they can be tested before final release.

About

Remnant: From the Ashes item checklist web app

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE_APACHE
MIT
LICENSE_MIT

Stars

Watchers

Forks

Packages

No packages published