@iammattburns/react-package-boilerplate
v1.0.1
Published
A boilerplate for creating React packages with Rollup, Storybook, and Typescript.
Downloads
1
Maintainers
Readme
React Package Boilerplate
This boilerplate aids in creating React packages utilizing Rollup, Storybook, and Typescript. Kickstart your React library development with a configuration that provides a seamless development experience.
Features
- Rollup: Efficiently bundles your React components for optimal use in other projects.
- Storybook: Visually test and showcase your components in an isolated environment.
- Typescript: Benefit from static type checking and the latest ECMAScript features.
Getting Started
Prerequisites
Ensure you have the following software installed:
- Node.js (v12 or newer)
- Yarn or npm
Installation
Clone the repository:
git clone https://github.com/iammattburns/react-package-boilerplate.git
Move to the project directory:
cd react-package-boilerplate
Install dependencies:
npm install
Development
#####Running Storybook To start the Storybook server:
npm run storybook
This will start the Storybook server, and you can begin developing your components.
Building the Package
To build the React components for distribution:
npm run build
This will produce an optimized bundle in the dist directory, ready for publishing.
Publishing
Once you are ready to publish your package:
- Modify the
package.json
with your package name, description, repository information, and other relevant details. - Run the build script.
- Publish to npm:
npm publish
Contributing
We welcome contributions! Please see CONTRIBUTING.md
for guidelines on how to proceed.
License
This project is licensed under the MIT License. See the LICENSE
file for more details.