https://github.com/fourkitchens/scrummy-react-dom
♠️♣️♥️♦️
https://github.com/fourkitchens/scrummy-react-dom
Last synced: 12 months ago
JSON representation
♠️♣️♥️♦️
- Host: GitHub
- URL: https://github.com/fourkitchens/scrummy-react-dom
- Owner: fourkitchens
- Created: 2016-09-09T20:43:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-03T16:41:53.000Z (over 7 years ago)
- Last Synced: 2025-03-27T18:22:21.272Z (about 1 year ago)
- Language: JavaScript
- Homepage: http://playscrummy.com
- Size: 656 KB
- Stars: 5
- Watchers: 28
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# scrummy-react-dom
[](https://fourkitchens.com/)
[](https://travis-ci.org/fourkitchens/scrummy-react-dom/)
[](https://codecov.io/gh/fourkitchens/scrummy-react-dom)
[](https://codeclimate.com/github/fourkitchens/scrummy-react-dom)
[](https://david-dm.org/fourkitchens/scrummy-react-dom)
[](https://david-dm.org/dev/fourkitchens/scrummy-react-dom#info=devDependencies&view=table)
## Contributors
[](https://github.com/fourkitchens) | [](https://github.com/tsmith512) | [](https://github.com/flipactual) | [](https://github.com/infiniteluke)
--- | --- | --- | ---
[Four Kitchens](https://github.com/fourkitchens) | [Taylor](https://github.com/tsmith512) | [Flip](https://github.com/flipactual) | [Luke](https://github.com/infiniteluke)
## Setup
* `yarn` For faster, deterministic, dependency management, install [yarn](https://yarnpkg.com/en/docs/install). For more information on how to use yarn see the [docs](https://yarnpkg.com/en/docs/cli/).
* `npm install` is not necessary if you use `yarn` but it also works.
## Storybook
[Storybook](https://github.com/kadirahq/react-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 `.scss` file. `src/scss/main.scss` contains all component imports along with other global imports.
## Scripts
### `build` – build the app
```sh
npm run build
```
### `start` – start a server for the developing the app
```sh
npm run start
```
### `test` – test the app
```sh
npm run test
```
### `test-watch` – test the app and re-run on save
```sh
npm run test-watch
```
### `view-coverage` – view test coverage
```sh
npm run view-coverage
```
### `check-coverage` – check that test coverage is :100:
```sh
npm run check-coverage
```
### `watch-coverage` – check test coverage as you write tests
```sh
npm run watch-coverage
```
### `lint-code` – lint the codebase
```sh
npm run lint-code
```
### `lint-writing` – lint docs for grammar
```sh
npm run lint-writing
```
### `coverage` – generate test coverage
```sh
npm run coverage
```
### `quality` – check code quality
```sh
npm run quality
```
### `write-readme` – generate README
```sh
npm run write-readme
```
### `storybook` – run storybook and hot reload changes
```sh
npm run storybook
```
### `build-storybook` – build storybook as static site
```sh
npm run build-storybook
```
### `analyse-bundle` – show bundled content as convenient interactive zoomable treemap
```sh
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](https://github.com/fourkitchens/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](https://github.com/fourkitchens)