chi3236/dmk-token-guide-public

DMK Token Guide

Purpose

This is a companion app to Disney Magic Kingdoms. It allows players to input their collection information, see token conflicts, and plan level-ups. The original purpose of this app was to display conflicting tokens for a searched character, intended to help prevent creating token conflicts with event characters, and it has grown tremendously from there. See it in action at https://dmktokenguide.com/

Versions

I am currently using node 16.4.0 and npm 7.18.1

Scripts

• client: Runs React code from top level directory
• server: Runs server-side code from top level directory
• build-client: Builds React code from top level directory
• update-main: Merge dev to main, pushes both, and checks out dev again
• merge-dev: Merge dev to main
• push-main: Push dev and main
• updatedb: Update db
• devnotes: Update dev notes
• event: Update event data and storyline
• storyline: Update event storyline
• tc: Update TC data
• manual: Runs manual updates, generally things not covered by scripts

Technologies

• Frontend:
  • React
  • Create-react-app
  • Redux
  • React-query - replacing Redux
  • Materialize CSS
  • Material UI - replacing Materialize
• Backend:
  • Node
  • Postgres
  • Knex
  • Bookshelf

Updating data

• The updatedb script covers most updates, but there are some limitations
• If new characters are added, their tokens need to be added in updateCharacterTokens.js as well, and often updatedb needs to be run twice because it tries to add tokens to tasks before creating the tokens (I just haven't bothered to fix this)
• The manual scripts are for things the other scripts don't cover, such as updating the level of a character for a task

Deploying

• Updates that are just data, no FE changes: run update-main and then git pull on the server and run whatever script(s) needed to update the data
• FE changes:
  • Increment app version in App.js and devNotes.js (and CHANGELOG.md)
  • Merge dev to main and run a build (I don't bother keeping dev up to date with builds so I don't merge back to dev)
  • Commit new build and push, then pull on server and run devNotes script

How to Take Up the Mantle

If you're interested in running the site, I am happy to transfer ownership of the domain. Unfortunately I'm using my server for multiple other projects as well, so you would have to set up your own. I am currently running it on a Digital Ocean droplet that costs me $7-8 per month. Digital Ocean has good guides for setting things up. Feel free to build your own version, this repo has a lot of old spaghetti and if I had all the time in the world I would completely rebuild it.

Work in Progress

There's a lot of refactoring in the works that I just do not have time to complete.

• Updating old class components to use hooks
• Replacing redux with react-query
• Replacing materialize-css with material ui

Planned Work & User Requests

I will work on adding these as Git issues.