{"id":15504740,"url":"https://github.com/alanbsmith/component-library-playground","last_synced_at":"2025-03-28T18:44:22.800Z","repository":{"id":78447947,"uuid":"138316772","full_name":"alanbsmith/component-library-playground","owner":"alanbsmith","description":"a playground for the component library workshop","archived":false,"fork":false,"pushed_at":"2018-06-22T15:09:40.000Z","size":85,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-02T19:34:00.869Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alanbsmith.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-22T15:09:24.000Z","updated_at":"2018-09-19T23:45:16.000Z","dependencies_parsed_at":"2023-04-24T10:28:59.590Z","dependency_job_id":null,"html_url":"https://github.com/alanbsmith/component-library-playground","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanbsmith%2Fcomponent-library-playground","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanbsmith%2Fcomponent-library-playground/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanbsmith%2Fcomponent-library-playground/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alanbsmith%2Fcomponent-library-playground/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alanbsmith","download_url":"https://codeload.github.com/alanbsmith/component-library-playground/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246083087,"owners_count":20720909,"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":"2024-10-02T09:19:48.566Z","updated_at":"2025-03-28T18:44:22.792Z","avatar_url":"https://github.com/alanbsmith.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Component Library Playground\n\n## Overview\n\nThis is a simple starter to get you up and running with Styled Components. This is intended to provide:\n\n- a lightweight Webpack config (for development and production)\n- configuration for theming and fetching fonts from a CDN\n- helpful tooling for development workflow\n  - Test setup with Jest and Enzyme\n  - ESLint / Stylelint\n\n## Up \u0026 Running\n\nInstall dependencies:\n\n```\n$ yarn install\n```\n\nFire up a development server:\n\n```\n$ yarn dev\n```\n\nOnce the server is running, you can visit `http://localhost:8080/`\n\n## Linting\n\n```\n$ npm i -g eslint eslint-watch\n```\n\nor if you need permissions:\n\n```\n$ sudo npm i -g eslint eslint-watch\n```\n\nTo run the linter once:\n\n```\n$ yarn lint\n```\n\nTo run the watch task:\n\n```\n$ yarn lint:watch\n```\n\n## Testing\n\nAn initial test suite has been setup with two tests (one passing and one intentionally failing).\nWe're using Jest and Enzyme for our test setup. The basic test setup lives in `./__tests__`.\nThe main configuration for Jest lives at the bottom of `package.json`. I've also added a few\nhandy scripts, which I've listed below. Jest also gives us a test coverage tool for free, so I've added that too. The setup is at the bottom of `package.json`. Everything is set to 90% coverage, but your welcome to update that to whatever you'd like.\n\nTo run the tests once:\n\n```\n$ yarn test\n```\n\nTo run the watch script (for only relevant test files)\n\n```\n$ yarn test:watch\n```\n\nTo run the watch script (for all test files)\n\n```\n$ yarn test:watchAll\n```\n\nTo view the coverage report:\n\n```\n$ yarn test:coverage:report\n```\n\n## Review\n\nIf you'd like to run the linter and tests at once (this is a nice check before pushing to Github or deploys), you can run:\n\n```\n$ yarn review\n```\n\n## Production Build\n\nTo build your production assets and run the server:\n\n```\n$ yarn start\n```\n\n## Changelog\n\nLooking for a particular version? View the [Changelog](CHANGELOG.mb)\n\n## Contributing\n\nI am thankful for any contributions made by the community. By contributing you agree to abide by the Code of Conduct in the [Contributing Guidelines](.github/CONTRIBUTING.md)\n\n## License\n\n[MIT](LICENSE)\n\n## DEPLOYING TO HEROKU\n\nThis app is set up for deployment to Heroku!\n\n_This assumes you have already have a Heroku account and have the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) installed_\n\n```\n$ heroku login\n$ heroku create -a name-of-your-app\n$ git push heroku master\n$ heroku open\n```\n\nHeroku will follow the `build` command in your `package.json` and compile assets with `webpack.prod.config.js`. It runs the Express web server in `server.js`.\n\nIf you're unfamiliar with Heroku deployment (or just need a refresher), they have a really great walkthrough [here](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanbsmith%2Fcomponent-library-playground","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falanbsmith%2Fcomponent-library-playground","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falanbsmith%2Fcomponent-library-playground/lists"}