React Kindling

Overview

React Kindling is a starter kit designed for React component and hook libraries. It provides everything necessary to build a React library, including a standalone documentation site using GitHub Pages. With features like TypeScript support, Storybook stories, README template, GitHub Pages pre-configuration, and easy npm publish capabilities, React Kindling offers a comprehensive solution for developers looking to create and share React components.

Features

• TypeScript support: Enables type checking and adds a layer of safety to the code.
• Storybook stories: Visualize components as you build them by creating stories in Storybook.
• README template: Easy-to-fill template with npm and deploy badges for enhanced visibility.
• GitHub Pages pre-configuration: Automatically deploy Storybook documentation to GitHub Pages.
• Easy npm publish: Simplifies the build, versioning, and shipping process with a single command (npm run ship).

Installation

1. Click the button to get started with React Kindling.
2. Install dependencies.
3. Update the site title in .storybook/theme.js.
4. Customize the favicon files in the public directory.
5. Use Storybook to develop components and hooks.
6. Export modules from index.tsx.
7. Keep boilerplate in sync by using LockBlocks for updater support.

Summary

React Kindling is a versatile tool that streamlines the process of building and sharing React libraries. By offering features like TypeScript support, Storybook integration, and easy npm publishing, it caters to developers looking for an efficient solution for creating React components and hooks. With pre-configured GitHub Pages deployment and a user-friendly README template, React Kindling simplifies the development and sharing of React projects.