A template to create a React component / library with Typescript
MIT License
A template to create a react component / library with Typescript.
Typedoc
for API documentationcommitlint
for conventional-commitsPrettier
and ESLint
integration with git hooksexample app
generation for testingGithub Pages
integrationClone the repository:
git clone --depth 1 [email protected]:alioguzhan/react-typescript-library.git
Rename the cloned folder to your library/component name:
mv react-typescript-library my-react-lib
Install the deps:
cd my-react-lib
yarn install
Once the installation is completed, A prompt will welcome you. Answer those questions and the installer will bootstrap the environment for you.
You can check if there are any outdated package with npm-check-updates tool.
Write your library code to src/index.tsx
file and run:
yarn start
This will watch your changes and reloads the server.
This setup expects you to follow conventional-commits format. There is a husky command runs before every commit for validation.
To learn more about conventional commits see its website.
You can remove that section from package.json
also remove the related package(s):
yarn remove -D @commitlint/cli
Run:
yarn build
This will create your compiled files under ./dist
folder. And generates a documentation with TypeDoc
under ./docs
folder.
Jest is configured and ready to use. Just run:
yarn test
This template uses TypeDoc by default.
Run 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.