https://github.com/permafrost-dev/react-component-library-skeleton
A template for creating React component libraries using Typescript, Prettier, ESLint, Biome, Vite, and Jest.
https://github.com/permafrost-dev/react-component-library-skeleton
Last synced: over 1 year ago
JSON representation
A template for creating React component libraries using Typescript, Prettier, ESLint, Biome, Vite, and Jest.
- Host: GitHub
- URL: https://github.com/permafrost-dev/react-component-library-skeleton
- Owner: permafrost-dev
- License: mit
- Created: 2024-01-20T18:28:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T11:44:33.000Z (about 2 years ago)
- Last Synced: 2024-05-01T11:30:38.542Z (about 2 years ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# React Component Library Template
---
## About
This is a template for creating a React component library using Typescript, Prettier, ESLint, Biome, Vite, and Jest.
It comes with a pre-configured CI/CD pipeline for Github Actions, and a node script to compile the typescript type definitions into a single file for distribution.
## Configuration
```bash
node configure.cjs
```
## Testing
`package-skeleton` uses Jest for unit tests. To run the test; suite:
```bash
npm run test
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Patrick Organ](https://github.com/permafrost-dev)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.