{"id":16773972,"url":"https://github.com/wayou/react-lib-starter","last_synced_at":"2026-04-10T15:37:17.815Z","repository":{"id":69158812,"uuid":"148040766","full_name":"wayou/react-lib-starter","owner":"wayou","description":"A react component boilerplate with tech stack of react, typescript, sass, jest, storybook, rollup, closure","archived":false,"fork":false,"pushed_at":"2018-09-10T03:01:28.000Z","size":522,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-23T04:15:07.689Z","etag":null,"topics":["closure","jest","react","rollup","sass","storybook","stylelint","tslint","typesctipt"],"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/wayou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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-09-09T15:50:12.000Z","updated_at":"2018-09-10T03:00:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"4054aaee-c395-47c5-abd4-6ea731990771","html_url":"https://github.com/wayou/react-lib-starter","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/wayou%2Freact-lib-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Freact-lib-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Freact-lib-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wayou%2Freact-lib-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wayou","download_url":"https://codeload.github.com/wayou/react-lib-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243903180,"owners_count":20366438,"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":["closure","jest","react","rollup","sass","storybook","stylelint","tslint","typesctipt"],"created_at":"2024-10-13T06:47:38.009Z","updated_at":"2025-12-30T22:34:50.921Z","avatar_url":"https://github.com/wayou.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-lib-starter\n\n[![CircleCI](https://circleci.com/gh/wayou/react-lib-starter.svg?style=svg)](https://circleci.com/gh/wayou/react-lib-starter)\n[![MIT LICENSE](https://img.shields.io/github/license/wayou/react-lib-starter.svg)](./LICENSE)\n[![npm package](https://img.shields.io/npm/v/react-lib-starter.svg)](https://www.npmjs.com/package/react-lib-starter)\n[![npm package](https://img.shields.io/npm/dt/react-lib-starter.svg)](https://www.npmjs.com/package/react-lib-starter)\n\nA react component boilerplate with tech stack of\n\n- react: UI framework\n- typescript: for type checking\n- sass: for css processing\n- jest: for tests\n- tslint \u0026 stylelint: for lint\n- storybook: for demo\n- rollup: for bundling\n- closure: for code comporession\n\n### Setup\n\n- clone repo\n- remove `.git` directory\n- alter README, rollup config files and others to meet your requirments\n- `yarn install`\n- `yarn start` to start development. this will start a local server and open http://localhost:3000 to see demo with live reload.\n\n\nother available scripts:\n\n- `yarn build` to generate dist output\n- `yarn test` to run tests\n- `yarn storybook` to start local storybook\n- `yarn storybook:deploy` to deploy storybook to github pages\n\n\n#### Circle CI configuration\n\nHere we use a CI service to\n- generate `dist` files\n- run tests and lint\n- deploy stories to github pages\n\nEither Travis or Circle CI will do, in this boilerplate we use the latter.\n\nTo intergrate Circle CI and make it work\n\n- update the username and email in [.circleci/config.yml](./.circleci/config.yml)\n- setup `GH_TOKEN` environment variables in Circle CI for the project\n  - generate a github personal access tokens from `https://github.com/settings/tokens`\n  - add an environment variable called  `GH_TOKEN` in Circle CI project setting page `https://circleci.com/gh/\u003cuser_name\u003e/\u003crepo_name\u003e/edit#env-vars` and it's value is the github personal access token above.\n- give Circle CI write access for the repo by adding suer key at `https://circleci.com/gh/\u003cuser_name\u003e/\u003crepo_name\u003e/edit#checkout`\n\n\n**BELOW IS A TEMPLATE README FOR THE COMPONENT**\n---\n\n\n### Features\n\n**List features as list.**\n\n- feature one\n- feature two\n- ...\n\n\n### Installing\n\nUsing command line:\n\n```bash\n$ yarn add \u003cpackage_name\u003e\n# or\n$ npm i -S \u003cpackage_name\u003e\n```\n\nUsing cdn:\n\n```html\n\u003cscript src=\"//unpkg.com/\u003crepo_name\u003e/dist/MyComponent.umd.js\"\u003e\u003c/script\u003e\n```\n\n### Usage\n\n**A simple usage demonstration with code goes here.**\n\n```js\nimport YourComponent from '\u003cpackage_name\u003e';\n\nclass Example extends React.Component{\n  public render(){\n    return \u003cYourComponent /\u003e\n  }\n}\n```\n\n### Options\n\n**List and describe available options for your component.**\n\n- `optoin`: description goes here\n  - type: `string`\n  - default: `the default value`\n- `callback`: description goes here\n  - type: `(event: Event) =\u003e void`\n\n\n### Examples\n\n**Publish stories to github pages for online demo.**\n\nSee the [examples](https://\u003cuser_name\u003e.github.io/\u003cpackage_name\u003e/index.html).\n\n\n#### Run the example at local\n\nclone this repo then:\n\n```bash\n$ yarn install \u0026\u0026 yarn start\n```\n\nnavigate to http://localhost:3000\n\n\n### Development\n\n**Describe how others can run the project local and contribute.**\n\nFor development, clone this repo then\n\n```bash\n$ yarn install \u0026\u0026 yarn start\n```\n\nthis will start a local server then open browser and go to http://localhost:3000 to see examples in action.\n\navailable scripts:\n\n- `build`: generate budnles that are ready to publish\n- `dev`: start local server for local development\n- `lint`: run tslint \u0026 stylelint\n- `test`: test the component\n\n\n### Acknowledgement\n\n**Other infomation that may help**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayou%2Freact-lib-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwayou%2Freact-lib-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwayou%2Freact-lib-starter/lists"}