Skip to content

TGRstack/example-games

Repository files navigation

TGR-Games

Compilation of example games made with prototype of `tr-games` module


Getting Started

git clone https://github.com/Falieson/tgr-games.git
npm i -D
nps

Usage

File Structure

src/
├── app/          - global app stuff
├── components/   - the pieces used in the routes, abstracts modules
├── helpers/      - useful functions
├── middlewares/  - third-party HOC functionality (apollo, router)
├── modules/      - first-party modules
    ├── gx        - author hasn't published rc4 which fixes a broken package
    ├── wizard    - prototyping the module before extracting it to its own module
├── routes/       - define page for a route
├── types/        - ts modules, common, interfaces

Notable Features

  • the module's theme.scss set vars that define the UI's palette
  • the wizard is controlled by UrlSearchParams, can link to a page of the wizard
  • the module is a WizardBuilder
    • a HOC that makes composing different Wizard UIs easy
    • while coordinating logic between the Wizard's parts
    • can pass themes to the Builder too
  • React16 Context to pass data to components while skipping intermediary components

TL;DR;

  • The #1 LI in the "Docs" list below has lots of info about the underlying stack
  • the only thing you really need to know to get started are 2 commands: npm i -D && nps

A bit more...

  • s?css.d.ts is generated by the webpack watcher

The base stack isn't ready for prod

  • the stack is made for app development
  • it uses webpack-dev-server to deliver a standard development environment
  • production stage for the tgr-app isn't done yet, which means the goal of being able to run nps build.prod and get a dist/ that can be consumed by tgr-mono(monolith) or tgr-fullstack(prototyping) apps.
  • this app does't include an express-server so running build.prod doesn't give you something easily useable.

Docs

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •