https://github.com/maxgfr/typescript-react-lib-swc

A minimalist typescript swc starter for creating react library of components
https://github.com/maxgfr/typescript-react-lib-swc

boilerplate boilerplate-components-library components-library gh-pages jest nodemon package prettier react react-boilerplate rust-compiler semantic-release starter-kit storybook testing-library typescript

Last synced: 7 days ago
JSON representation

A minimalist typescript swc starter for creating react library of components

• Host: GitHub
• URL: https://github.com/maxgfr/typescript-react-lib-swc
• Owner: maxgfr
• License: mit
• Created: 2022-11-08T13:42:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T13:57:29.000Z (7 months ago)
• Last Synced: 2024-04-13T21:38:12.801Z (7 months ago)
• Topics: boilerplate, boilerplate-components-library, components-library, gh-pages, jest, nodemon, package, prettier, react, react-boilerplate, rust-compiler, semantic-release, starter-kit, storybook, testing-library, typescript
• Language: TypeScript
• Homepage: https://maxgfr.github.io/typescript-react-lib-swc
• Size: 5.05 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# typescript-react-lib-swc

A simple react boilerplate for creating a library of components made in typescript using `swc`.

It also uses:

- `storybook` for viewing a components

- `testing-library` for testing components

- `semantic-release` for publishing a package for this library components

## Clone repository and install dependencies

```sh

git clone https://github.com/maxgfr/typescript-react-lib-swc # For cloning the repository

cd typescript-react-lib-swc # To navigate to the repository root

yarn # Install dependencies

```

## Building the code

```sh

yarn build # For building the code with typechecking

yarn build:swc # For building without typechecking

```

> **:warning: No typechecking made in dev mode**

## Testing the code

```sh

yarn test # For running unit test

yarn test:watch # For watching unit test

```