{"id":15654159,"url":"https://github.com/alioguzhan/react-typescript-library","last_synced_at":"2025-04-30T22:48:51.869Z","repository":{"id":41963197,"uuid":"242535065","full_name":"alioguzhan/react-typescript-library","owner":"alioguzhan","description":"A template to create a React component / library with Typescript","archived":false,"fork":false,"pushed_at":"2023-12-01T00:20:41.000Z","size":2139,"stargazers_count":34,"open_issues_count":2,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-30T22:48:44.115Z","etag":null,"topics":["react","react-library","react-typescript-module","typescript"],"latest_commit_sha":null,"homepage":"","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/alioguzhan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2020-02-23T14:49:05.000Z","updated_at":"2024-12-20T20:18:10.000Z","dependencies_parsed_at":"2024-10-23T03:47:55.258Z","dependency_job_id":"4bcc4ecb-132c-42af-b7b9-f758ee5ff396","html_url":"https://github.com/alioguzhan/react-typescript-library","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alioguzhan%2Freact-typescript-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alioguzhan%2Freact-typescript-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alioguzhan%2Freact-typescript-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alioguzhan%2Freact-typescript-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alioguzhan","download_url":"https://codeload.github.com/alioguzhan/react-typescript-library/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251795386,"owners_count":21645019,"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":["react","react-library","react-typescript-module","typescript"],"created_at":"2024-10-03T12:49:46.451Z","updated_at":"2025-04-30T22:48:51.852Z","avatar_url":"https://github.com/alioguzhan.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./tools/tsreact.png\" width=\"500\" alt=\"react loves typescript\"\u003e\n\u003c/div\u003e\n\n# React Typescript Library Template\n\nA template to create a react component / library with Typescript.\n\n- React\n- Typescript\n- Rollup\n- Css Modules\n- Jest with code coverage report\n- `Typedoc` for API documentation\n- `commitlint` for conventional-commits\n- `Prettier` and `ESLint` integration with git hooks\n- Optional `example app` generation for testing\n- `Github Pages` integration\n- Release-Please workflow\n\n## Install\n\nClone the repository:\n\n```\ngit clone --depth 1 git@github.com:alioguzhan/react-typescript-library.git\n```\n\nRename the cloned folder to your library/component name:\n\n```\nmv react-typescript-library my-react-lib\n```\n\nInstall the deps:\n\n```bash\ncd my-react-lib\nyarn install\n```\n\nOnce the installation is completed, A prompt will welcome you. Answer those questions and the installer will bootstrap the environment for you.\n\n\u003e You can check if there are any outdated package with [npm-check-updates](https://www.npmjs.com/package/npm-check-updates) tool.\n\n## Development\n\nWrite your library code to `src/index.tsx` file and run:\n\n```\nyarn start\n```\n\nThis will watch your changes and reloads the server.\n\n### Commit Messages\n\nThis setup expects you to follow conventional-commits format. There is a husky command runs before every commit for validation.\n\nTo learn more about conventional commits see [its website](https://www.conventionalcommits.org/en/v1.0.0/).\n\nYou can remove that section from `package.json` also remove the related package(s):\n\n```\nyarn remove -D @commitlint/cli\n```\n\n## Build\n\nRun:\n\n```\nyarn build\n```\n\nThis will create your compiled files under `./dist` folder. And generates a documentation with `TypeDoc` under `./docs` folder.\n\n## Test\n\nJest is configured and ready to use. Just run:\n\n```\nyarn test\n```\n\n## Docs\n\nThis template uses [TypeDoc](https://typedoc.org/) by default.\n\nRun `yarn make:docs` and a folder named `docs` will be created in your root directory. Just open `index.html` in your browser to see if your like it or not.\n\n## CREDITS\n\n- Logo Design by [@fyunusyildiz](https://github.com/fyunusyildiz)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falioguzhan%2Freact-typescript-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falioguzhan%2Freact-typescript-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falioguzhan%2Freact-typescript-library/lists"}