Rewrite the Adagrams demo app using Ink

[mmcknett]

Adagrams demo game rewrite

Motivation and Architecture

This PR is a rewrite of the Adagrams demo-game. It includes an Architectural Decision Record explaining the motivation and details of the decision to rewrite. If this PR is accepted and merged, consider that ADR also accepted.

The new application is written with Ink, which allows you to build CLI applications with React. Several prominent CLI tools, including jest, depend on this framework. The application's architecture is documented in README files in its folders, and is intended to walk inquisitive students through the organization and design of the app, in an attempt to fulfill the goals of the ADR.

Testing

You can test the branch locally. If you've already cloned the repo, you can add my fork as a remote, install, and run:

git remote add mmcknett https://github.com/mmcknett/js-adagrams.git
git fetch mmcknett
git checkout mmcknett/mm-ink-demo-app
yarn install
yarn run demo-game

The unit tests should pass except for adagrams, since that isn't implemented:

yarn test

You should be able to test the demo with a working Adagrams solution by merging c17/solution into it. Just don't push the merge commit. If this PR is accepted, I will rebase the solutions onto main.

git merge c17/solution

PR work tracking

Items remaining prior to PR publish:

• Documentation, including...
  • Motivation (i.e. why do this rewrite?)
  • Brief overview of Ink
  • Brief overview of the app architecture, especially focusing on the reducer and some of the more esoteric parts like the Timer
• Final pass-through to make sure the React is canonical and represents best practices that we would want inquisitive students to emulate.
  • Also want to investigate whether babel is still necessary for transpilation (e.g. of the js modules)
• Automated tests
  • current tests were all manual; I was having trouble thinking about how to test Ink apps
  • Ink testing seems to have some issues running useEffect prior to stdin.write calls. I was able to generally work around the issue by rerendering after any changes to the React tree could be expected, but it seems likely there is either some trouble between Ink and recent versions of React or that I missed some necessary testing setup.
• Rebase on main
• Update root repo README for the new game