Weather App (TGRStack)

Docs

Check out the folder called docs => ./docs/

• ASSIGNMENT.md - the coding homework
• JOURNAL.md - my thoughts along the way
• PLAN.md - plan of commits and notes for gold plating

Packages

  "dependencies": {
    "@tgrx/apollo-link-rest": "0.6.1",  # TGR - incorporates PRs not yet published
    "@tgrx/apollo-link-state": "0.4.3", # TGR - incorporates PRs not yet published
    "@tgrx/gx": "1.0.0-rc4",            # TGR - incorporates PRs not yet published
    "react": "16.7.0-alpha.2",          # EXPERIMENTAL RELEASE
  },
  "devDependencies": {
    "@tgrx/tslint-config-tgr": "5.0.0", # TGR - tslint settings for minimial clutter

Demo

Check out the netlify demo link: https://tgr-weather.netlify.com

Getting Started

After you've cloned this repo and ran npm i -D, do the following:

in your terminal:

$ nps ss                # Start the dev server

in your browser console:

$ reopenMobile()       # reopen the window the size of iPhone6/7/8

go ahead and close the old browser.

Commands

* nps                   # Executes all the tooling
* nps help              # Displays all available commands
* nps commit            # Creates a commit, don't use `git commit -m ...`
* nps build             # Builds the module
* nps lint              # Lint checks the module
* nps test              # Test checks the module

Stack

Docs

• HowTo make a TS Module w/ Declarations
• TS-Module
• TS-React-App
• TS-GraphqL-Endpoint

Badges

File Structure

src/
├── app/          - global app stuff
├── components/   - the pieces used in the routes, abstracts modules
├── middlewares/  - third-party HOC functionality (apollo, router)
└── modules/      - first-party modules
    └── ui        - prototyping the module before extracting it to its own module
├── routes/       - define page for a route
├── types/        - ts modules, common, interfaces
└── utils/      - useful functions

Features

Core

• 🚀 ES2018+ support syntax that is stage-3 or later in the TC39 process.
• 🎛 Preconfigured to support development and optimized production builds
• 🎶 typescript incremental returns reducing development bugs
• 💎 apollo-client w/ link-state instead of react-redux

React

• 🐉 React 16+
• 👾 HMR reloads the Changed Code w/o refreshing the entire page

CSS

• 🌅 typings-for-css-modules-loader replaces 'css-loader' for webpack
• 🎠 typings-for-css-modules-loader generates d.ts for css files
• 🌇 sass-loader adds vars, imports, heirarchies to css.
• replace sass support w/ stylable.io

Style

• 🚦 tslint configured for strict, consistent, code style
• 🚦 ts-prettier for some of that code-consistancy that's missing from tslint
• 🚦 SonarTS Static code analyzer detects bugs and suspicious patterns

Tests

• 🎭 jest as the test framework.
• 🎭 ts-jest configured to test TS files, uses tsconfig.jest.json, and skip babel.
• 🎭 enzyme makes it easier to assert, manipulate, and traverse components.
• 🎭 react-testing-library maintainable tests that avoid impl. details.
• 🎭 jest-dom patterns for dom testing, compat w/ react-testing-library.

Build (w/ Webpack)

• 📦 All source is bundled using Webpack v4
• 🌟 webpack for dev, prod, common
• 🚦 ts-loader for compiling typescript
• 🚦 webpack-graphql-loader for separating gql from ts files
• 💦 babel-loader for additional polyfills (browser support)
• 😎 HappyPack
• 🤖 Auto generated Vendor DLL for smooth development experiences
• 🍃 Tree-shaking

Utils

• 🎮 nps node-package-scripts removes the limitation of package.json enabling JS & //comments . Modify /package-scripts.js and use nps <command> instead of npm run <command>.
• 🙌 commitizen to help us generate beautifully formatted and consistent commit messages.
• 😹 cz-emoji is a plugin for commitizen that adds emoji to the commit template.
• 🏆 standard-version is a replacement for npm version with automatic CHANGELOG generation
• ✅ commitlint validates commit messages to follow commitizen patterns