{"id":19147640,"url":"https://github.com/adamjarling/starter-react-component-npm","last_synced_at":"2026-04-08T21:31:48.781Z","repository":{"id":40753704,"uuid":"235420638","full_name":"adamjarling/starter-react-component-npm","owner":"adamjarling","description":"Starter boilerplate code repository for an environment which packages a React component as an NPM package, along with allowing local development.","archived":false,"fork":false,"pushed_at":"2023-01-06T02:27:35.000Z","size":2298,"stargazers_count":0,"open_issues_count":28,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-11T11:11:42.595Z","etag":null,"topics":["component-library","jest","react","rollup","styled-components","styleguidist","testing-library-react"],"latest_commit_sha":null,"homepage":"https://adamjarling.github.io/starter-react-component-npm/styleguide","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/adamjarling.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":"2020-01-21T19:09:16.000Z","updated_at":"2020-09-04T19:21:22.000Z","dependencies_parsed_at":"2023-02-05T03:01:50.474Z","dependency_job_id":null,"html_url":"https://github.com/adamjarling/starter-react-component-npm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/adamjarling/starter-react-component-npm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamjarling%2Fstarter-react-component-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamjarling%2Fstarter-react-component-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamjarling%2Fstarter-react-component-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamjarling%2Fstarter-react-component-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamjarling","download_url":"https://codeload.github.com/adamjarling/starter-react-component-npm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamjarling%2Fstarter-react-component-npm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31575452,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["component-library","jest","react","rollup","styled-components","styleguidist","testing-library-react"],"created_at":"2024-11-09T07:51:00.793Z","updated_at":"2026-04-08T21:31:48.761Z","avatar_url":"https://github.com/adamjarling.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# starter-react-component-npm\n\nA React component library boilerplate which:\n\n- includes React,\n- bundles CommonJS, UMD and ESModule JavaScript files,\n- provides a Styleguidist dev environment \u0026amp; component documentation,\n- provides unit test, best practice configuration\n- supports styled components (CSS) via @emotion.\n\n## Getting Started\n\n### Installing\n\nClone or fork the repository:\n\n```\ngit clone git@github.com:adamjarling/starter-react-component-npm.git\n```\n\nInstall dependencies (use Yarn or NPM...your choice but examples below use `yarn`)\n\n```\n# Yarn\nyarn install\n\n// or...\n\n# NPM\nnpm install\n```\n\n## Developing\n\nUse [Styleguidist](https://react-styleguidist.js.org/) as the development environment.\n\n```\nyarn styleguide\n```\n\nwhich will spin up a local Styleguidist webpack dev server that handles live-reloading as you write tests, build out components, and write documentation.\n\n## Tests\n\nUnit tests are set up to run using [Jest](https://jestjs.io/) and [@testing-library](https://testing-library.com/).\n\n```\nyarn test\n\n// or\nyarn test:watch\n```\n\n## Building the package\n\nTo build the package, we use [Rollup](https://rollupjs.org/):\n\n```\nyarn build\n```\n\nTo directly build the latest version of the style guide:\n\n```\nyarn styleguide:build\n```\n\n## Customizing\n\n1. Rename the project folder \"starter-react-component-npm\" to your own...ie: \"my-new-component\"\n\n2. Update the `/package.json` file to customize for your project. Especially `namme, description, keywords, author`, etc.\n\n## Deployment\n\n### Bundling\n\nWhen ready to bundle your component, run:\n\n```\nyarn build\n```\n\nThis will build a fresh copies of the package in the `/dist` folder. It will also build a fresh copy of the style guide in the `/styleguide` directory.\n\n### Push to NPM registry\n\nHere's how to publishing your package to NPM:\nhttps://docs.npmjs.com/cli/publish\n\nTo publish your package:\n\n```\nnpm publish\n```\n\n## Built With\n\n- [React](https://reactjs.org/) - JavaScript component library\n- [Rollup](https://rollupjs.org/) - Rollup JavaScript bundler\n- [Jest](https://jestjs.io/) - Testing framework\n- [Styleguidist](https://react-styleguidist.js.org/) - Local dev environment \u0026amp; documentation\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamjarling%2Fstarter-react-component-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamjarling%2Fstarter-react-component-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamjarling%2Fstarter-react-component-npm/lists"}