/scrummy-react-dom

♠️♣️♥️♦️

Primary LanguageJavaScript

scrummy-react-dom

Four Kitchens Travis Codecov Code Climate David Dependency Management David Dependency Management (dev)

Contributors

Four Kitchens Taylor Flip Luke
Four Kitchens Taylor Flip Luke

Setup

  • yarn For faster, deterministic, dependency management, install yarn. For more information on how to use yarn see the docs.
  • npm install is not necessary if you use yarn but it also works.

Storybook

Storybook allows one to develop/style components in isolation. Each component directory contains a respective story.js file.

Usage

  • npm run storybook
  • Visit http://localhost:6006
  • Develop/Style components as normal. Changes will be hot reloaded.

Styles

Each component directory contains a respective <Component>.scss file. src/scss/main.scss contains all component imports along with other global imports.

Scripts

build – build the app

npm run build

start – start a server for the developing the app

npm run start

test – test the app

npm run test

test-watch – test the app and re-run on save

npm run test-watch

view-coverage – view test coverage

npm run view-coverage

check-coverage – check that test coverage is 💯

npm run check-coverage

watch-coverage – check test coverage as you write tests

npm run watch-coverage

lint-code – lint the codebase

npm run lint-code

lint-writing – lint docs for grammar

npm run lint-writing

coverage – generate test coverage

npm run coverage

quality – check code quality

npm run quality

write-readme – generate README

npm run write-readme

storybook – run storybook and hot reload changes

npm run storybook

build-storybook – build storybook as static site

npm run build-storybook

analyse-bundle – show bundled content as convenient interactive zoomable treemap

npm run analyse-bundle

Local Backend Server Setup:

Note:

  • The deployed application connects to ws://scrummy-server.herokuapp.com.

Scrummy Server:

  • Copy config/example.local.yaml to config/local.yaml to connect to the Scrummy Server.
  • In the Scrummy Server repo change config/default.yml to have a port line that reads port: 8081.
  • Open two terminal windows and start up both apps with npm run start in the projects' root directories.
  • Go to: http://localhost:8080/webpack-dev-server/
  • Play Scrummy.

License

MIT @ Four Kitchens