https://effortlessmountain.github.io/ironsworn-asset-workbench/

An editor for custom Ironsworn assets. Currently under active development. https://effortlessmountain.github.io/ironsworn-asset-workbench/
https://effortlessmountain.github.io/ironsworn-asset-workbench/

Last synced: 2 months ago
JSON representation

An editor for custom Ironsworn assets. Currently under active development. https://effortlessmountain.github.io/ironsworn-asset-workbench/

• Host: GitHub
• URL: https://effortlessmountain.github.io/ironsworn-asset-workbench/
• Owner: effortlessmountain
• License: other
• Created: 2019-11-25T01:02:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T23:52:15.000Z (over 2 years ago)
• Last Synced: 2024-06-17T00:23:05.051Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 4.65 MB
• Stars: 18
• Watchers: 3
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-ironsworn - Asset Workbench - Tool for creating custom Ironsworn assets (Tools / Ironsworn)

README

        
The [Asset Workbench](https://effortlessmountain.github.io/ironsworn-asset-workbench/) is a tool for creating custom assets for the [Ironsworn Tabletop RPG](https://www.ironswornrpg.com/) (the base game is available for free!).

### Contributing

Thanks for lending a hand!

- Fork and create a pull request.

- Make sure all the tests pass (both unit and end to end tests).

### Technical to-do list:

- use Redux for state management.

- make site keyboard-navigable and generally accessible.

- make the HTML more semantic.

- investigate using a component library.

- consider using a style library.

- flesh out test coverage of components.

- revisit code organization.

- provide sane back button support (such as with a proper router).

### Developing

Run `npm install` to install dependencies, then `npm run start` to start a development server running at localhost:3000

### Running Tests

#### Unit Tests

`npm run test`

#### End to End (UI) Tests

`npm run cypress:open`

### Deploying

To deploy to the gh-pages branch of the repository using the `gh-pages` tool, run the following (requires access):

`npm run deploy`