{"id":23980838,"url":"https://github.com/fourkitchens/scrummy-react-dom","last_synced_at":"2025-07-08T07:06:51.889Z","repository":{"id":43619060,"uuid":"67831493","full_name":"fourkitchens/scrummy-react-dom","owner":"fourkitchens","description":"♠️♣️♥️♦️","archived":false,"fork":false,"pushed_at":"2019-01-03T16:41:53.000Z","size":672,"stargazers_count":5,"open_issues_count":4,"forks_count":4,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-03-27T18:22:21.272Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://playscrummy.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fourkitchens.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-09T20:43:44.000Z","updated_at":"2020-07-13T15:16:48.000Z","dependencies_parsed_at":"2022-08-20T05:22:50.672Z","dependency_job_id":null,"html_url":"https://github.com/fourkitchens/scrummy-react-dom","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fscrummy-react-dom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fscrummy-react-dom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fscrummy-react-dom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fourkitchens%2Fscrummy-react-dom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fourkitchens","download_url":"https://codeload.github.com/fourkitchens/scrummy-react-dom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248822836,"owners_count":21167124,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-07T10:18:55.748Z","updated_at":"2025-04-14T04:33:59.458Z","avatar_url":"https://github.com/fourkitchens.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# scrummy-react-dom\n\n[![Four Kitchens](https://img.shields.io/badge/4K-Four%20Kitchens-35AA4E.svg?style=flat-square)](https://fourkitchens.com/)\n[![Travis](https://img.shields.io/travis/fourkitchens/scrummy-react-dom.svg?style=flat-square)](https://travis-ci.org/fourkitchens/scrummy-react-dom/)\n[![Codecov](https://img.shields.io/codecov/c/github/fourkitchens/scrummy-react-dom.svg?style=flat-square)](https://codecov.io/gh/fourkitchens/scrummy-react-dom)\n[![Code Climate](https://img.shields.io/codeclimate/github/fourkitchens/scrummy-react-dom.svg?style=flat-square)](https://codeclimate.com/github/fourkitchens/scrummy-react-dom)\n[![David Dependency Management](https://img.shields.io/david/fourkitchens/scrummy-react-dom.svg?style=flat-square)](https://david-dm.org/fourkitchens/scrummy-react-dom)\n[![David Dependency Management (dev)](https://img.shields.io/david/dev/fourkitchens/scrummy-react-dom.svg?style=flat-square)](https://david-dm.org/dev/fourkitchens/scrummy-react-dom#info=devDependencies\u0026view=table)\n\n## Contributors\n\n[![Four Kitchens](https://avatars.githubusercontent.com/u/348885?s=130)](https://github.com/fourkitchens) | [![Taylor](https://avatars.githubusercontent.com/u/1486573?s=130)](https://github.com/tsmith512) | [![Flip](https://avatars.githubusercontent.com/u/1306968?s=130)](https://github.com/flipactual) | [![Luke](https://avatars.githubusercontent.com/u/1127238?s=130)](https://github.com/infiniteluke)\n--- | --- | --- | ---\n[Four Kitchens](https://github.com/fourkitchens) | [Taylor](https://github.com/tsmith512) | [Flip](https://github.com/flipactual) | [Luke](https://github.com/infiniteluke)\n## Setup\n\n* `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/).\n* `npm install` is not necessary if you use `yarn` but it also works.\n\n## Storybook\n\n[Storybook](https://github.com/kadirahq/react-storybook) allows one to develop/style components in isolation.\nEach component directory contains a respective `story.js` file.\n\n### Usage\n* `npm run storybook`\n* Visit http://localhost:6006\n* Develop/Style components as normal. Changes will be hot reloaded.\n\n## Styles\n\nEach component directory contains a respective `\u003cComponent\u003e.scss` file. `src/scss/main.scss` contains all component imports along with other global imports.\n\n## Scripts\n\n### `build` – build the app\n\n```sh\nnpm run build\n```\n\n### `start` – start a server for the developing the app\n\n```sh\nnpm run start\n```\n\n### `test` – test the app\n\n```sh\nnpm run test\n```\n\n### `test-watch` – test the app and re-run on save\n\n```sh\nnpm run test-watch\n```\n\n### `view-coverage` – view test coverage\n\n```sh\nnpm run view-coverage\n```\n\n### `check-coverage` – check that test coverage is :100:\n\n```sh\nnpm run check-coverage\n```\n\n### `watch-coverage` – check test coverage as you write tests\n\n```sh\nnpm run watch-coverage\n```\n\n### `lint-code` – lint the codebase\n\n```sh\nnpm run lint-code\n```\n\n### `lint-writing` – lint docs for grammar\n\n```sh\nnpm run lint-writing\n```\n\n### `coverage` – generate test coverage\n\n```sh\nnpm run coverage\n```\n\n### `quality` – check code quality\n\n```sh\nnpm run quality\n```\n\n### `write-readme` – generate README\n\n```sh\nnpm run write-readme\n```\n\n\n### `storybook` – run storybook and hot reload changes\n\n```sh\nnpm run storybook\n```\n\n### `build-storybook` – build storybook as static site\n\n```sh\nnpm run build-storybook\n```\n\n### `analyse-bundle` – show bundled content as convenient interactive zoomable treemap\n\n```sh\nnpm run analyse-bundle\n```\n\n## Local Backend Server Setup:\n\n### Note:\n* The deployed application connects to ws://scrummy-server.herokuapp.com.\n\n### Scrummy Server:\n* Copy `config/example.local.yaml` to `config/local.yaml` to connect to the [Scrummy Server](https://github.com/fourkitchens/scrummy-server).\n* In the Scrummy Server repo change `config/default.yml` to have a port line that reads `port: 8081`.\n* Open two terminal windows and start up both apps with `npm run start` in the projects' root directories.\n* Go to: http://localhost:8080/webpack-dev-server/\n* Play Scrummy.\n\n## License\n\nMIT @ [Four Kitchens](https://github.com/fourkitchens)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Fscrummy-react-dom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffourkitchens%2Fscrummy-react-dom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffourkitchens%2Fscrummy-react-dom/lists"}