ChooseYourFramework

Choosing a modern JavaScript UI framework, Pokemon-style.

Usage

This is a hacked-together fork of FullScreenShenanigans/FullScreenPokemon, which is itself very old code on the not-production-ready EightBittr game engine. No guarantees any of this stuff works.

Development

After forking the repo from GitHub:

git clone https://github.com/<your-name-here>/ChooseYourFramework
cd ChooseYourFramework
yarn
yarn run hydrate
yarn run compile

• yarn run hydrate creates a few auto-generated setup files locally.
• yarn run compile builds source code to lib/ with TypeScript

Tip: run yarn compile -w to keep TypeScript running in watch mode, so your output files stay up-to-date as you save source code.

Running Locally

Once you've run the setup commands above, lib/index.html will contain a working file you can directly open in a browser locally, such as with open lib/index.html on Mac or start lib/index.html on Windows.

Running Tests

yarn run test

Tests are written in Mocha and Chai. Their files are written using alongside source files under src/ and named *.test.ts?. Whenever you add, remove, or rename a *.test.t* file under src/, watch will re-run yarn run test:setup to regenerate the list of static test files in test/index.html. You can open that file in a browser to debug through the tests, or run yarn test:run to run them in headless Chrome.

Production Builds

yarn run dist

After running the dist command, the dist/ folder will contain project outputs optimized for running in production: i.e. versions of code that are concatenated into fewer files and minified. dist/index.html will be a more optimized version of lib/index.html.