React Components Library Starter

Welcome to the React Components Library Starter kit! This toolkit provides you with a solid foundation for building your own React components library.

Folder Structure and Examples

Explore the ./src/components/ directory to understand how to use and organize your components effectively.

./src/index.ts

This file serves as the entry point for your library and should export all your components from the ./src/components folder.

export * from './components';

./src/components/index.ts Example

Here's an example of how you can organize your components in the index.ts file within the components directory:

export { default as App } from "./App"
export { default as Counter } from "./Counter"
export { default as Form } from "./Form"

Build Script

The build script focuses on the following folders:

• src
• src/declarations/*

Additionally, it covers images to ensure comprehensive building.

Getting Started

To start using this starter kit, follow these steps:

1. Login:

   • Yarn:

   yarn login

   • npm:

   npm login

   • pnpm:

   pnpm login

2. Change Version: All Package Managers: Update the version of your library in the package.json file. Also, don't forget to change the author and description of the package. For example:

   {
     "name": "your-package-name",
     "version": "1.0.0",
     "author": "Your Name",
     "description": "Your package description",
     ...
   }

3. Build Your Library:

   • Yarn:

   yarn build:npm

   • npm:

   npm run build:npm

   • pnpm:

   pnpm build:npm

4. Publish:

   • Yarn:

   yarn publish

   • npm:

   npm publish

   • pnpm:

   pnpm publish

Congratulations! You've successfully built and published your React components library.

Feel free to customize and expand upon this starter kit to meet your specific requirements. Happy coding!