{"id":19157161,"url":"https://github.com/adrice727/typescript-react-storybook","last_synced_at":"2025-05-07T07:47:49.047Z","repository":{"id":57383911,"uuid":"133093548","full_name":"adrice727/typescript-react-storybook","owner":"adrice727","description":"A Starter Kit for Building a Reusable React Component Library","archived":false,"fork":false,"pushed_at":"2018-05-18T23:55:31.000Z","size":188,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-19T20:17:50.372Z","etag":null,"topics":["components","postcss","react","starter-project","storybook","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/adrice727.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}},"created_at":"2018-05-11T22:16:42.000Z","updated_at":"2021-04-24T04:29:32.000Z","dependencies_parsed_at":"2022-09-04T03:23:23.663Z","dependency_job_id":null,"html_url":"https://github.com/adrice727/typescript-react-storybook","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/adrice727%2Ftypescript-react-storybook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrice727%2Ftypescript-react-storybook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrice727%2Ftypescript-react-storybook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrice727%2Ftypescript-react-storybook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrice727","download_url":"https://codeload.github.com/adrice727/typescript-react-storybook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252839196,"owners_count":21812083,"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":["components","postcss","react","starter-project","storybook","typescript"],"created_at":"2024-11-09T08:38:31.437Z","updated_at":"2025-05-07T07:47:49.021Z","avatar_url":"https://github.com/adrice727.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![logo](./assets/logo.png)\n\n# TypeScript React Storybook\n\nA starter kit for building a reusable component library with [TypeScript](http://www.typescriptlang.org/), [React](https://reactjs.org/), and [Storybook](https://storybook.js.org/).\n\n## Quick Start\n\nTo get `Storybook` up and running with the provided example components:\n\n```bash\n$ yarn install\n$ yarn storybook\n```\nGo to `localhost:6000` in your browser.  You can start building your own components and stories.\n\n## CSS Configuration\n\nThe project is configured to use [`PostCSS`](https://github.com/postcss/postcss) and the following plugins:\n\n - [PreCSS](https://github.com/jonathantneal/precss)\n - [PostCSS Import](https://github.com/postcss/postcss-import)\n - [Autoprefixer](https://github.com/postcss/autoprefixer)\n - [PostCSS Mixins](https://github.com/postcss/postcss-mixins)\n\nYou can update the plugins by editing `postcss.config.js`.\n\nThe project uses the [`BEM`](http://getbem.com/naming/) naming convention for CSS classes in order to avoid CSS namespace collisions.  By default classes will use the package name defined in `package.json`:\n\n![bem](./assets/bem.png)\n\nYou can customize the naming convention by editing the `localIdentName` field in `webpack.config.js` and `.storybook/webpack.config.js`:\n```javascript\n  MiniCssExtractPlugin.loader,\n  {\n    loader: require.resolve('typings-for-css-modules-loader'),\n    options: {\n      . . .\n      localIdentName: `${packageName}_[name]__[local]`\n    }\n  },\n```\n\n[Nunito](https://fonts.google.com/specimen/Nunito) and [Source Code Pro](https://fonts.google.com/specimen/Source+Code+Pro) fonts are used by the provided example components.  You can customize the fonts included in the library by updating `src/styles/imports/font-face.css`\n\n\n## Build\n\nTo build the library for publishing or local testing, simply run:\n```bash\n$ yarn build\n```\n\nAfter building the library, you can test it in a local project by using [`yarn link`](https://yarnpkg.com/lang/en/docs/cli/link/), or publish it directly to `npm`.\n\nAll of the fonts, styles, and images will be included in the bundled build. Just import the stylesheet:\n```javascript\n// Inside your top-level component\nimport 'typescript-react-storybook/dist/style.css';\n```\nand then import and use the components as normal:\n\n```javascript\nimport { Button } from 'typescript-react-storybook';\n\nconst myComponent = () =\u003e\n  \u003cdiv\u003e\n    \u003cButton text=\"hello\" onClick={() =\u003e console.log('clicked'))} /\u003e\n  \u003c/div\u003e\n\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrice727%2Ftypescript-react-storybook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrice727%2Ftypescript-react-storybook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrice727%2Ftypescript-react-storybook/lists"}