Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.06 KB

README.md

File metadata and controls

49 lines (33 loc) · 2.06 KB

Dungeonwall (v0.6)

Build DM screens or layout player info in a nice masonry-style grid.

WIP; and on-hold while I get settled at a new job!

Demo: Demo is of version v0.2 - significant changes have gone in since this version. Screenshot of Dungeonwall Video View at: https://www.youtube.com/watch?v=fxwmahfIVFE

Running this Software

  • Run the server from the dungeonwall directory with 'npm run start'
  • Create a .env file -- see blank.env for format.
  • Create a mongoDB instance and start it up. Will be setting up a docker file to make this easier... eventually.
  • Run 'npm run sass' in the dungeonwall/frontend directory to make sure styles are up to date.
  • Run the front-end from the dungeonwall/frontend directory with 'npm run start'
  • Navigate to localhost:8080 to view the frontend. If everything went well, you should have the demo panels loaded.
  • There's a seedDB file you can run with 'npm run seed' to create a new wall with panels. You'll need to delete the wall if you need to reseed!

Known Bugs

  • Filters currently pointing at wrong things.
  • issues when saving an edit (not new panel)

Near Future Extensions

  • Adding some control over the wall itself (naming, color, etc)
  • Reconsider spacing of panels - would be nice to have these align better.
  • Multiple users
  • Better backend validation, authentication
  • UI should indicate keyboard controls!
  • Weird issue with screen height not filling BG

Future Extensions

  • Add controls for multiple walls (including having multiple pages on a wall)
  • Renameable panel types (esp to allow for other types of note pages)

Tech Debt Inventory

  • PanelOrder is duplicated in state - it exists as an attribute but also in dirtyContent. Yuck.
  • SeedDB still lackluster when I need to start again from scratch. Really need to prioritize using a docker file
  • Clean up the sass files, split them up a bit
  • Hardcoded keyboard controls... also, they would break on a non-QWERTY layout. Fix.