mirror of
https://github.com/aleleba/create-react-component-library.git
synced 2026-07-16 12:07:52 -06:00
Alejandro Lembke Barrientos
ce33af9093
Update 12 safe dependencies to their latest versions: - Storybook ecosystem (4 packages): ^10.4.6 → ^10.5.0 - @types/node: ^26.0.0 → ^26.1.1 - cypress: ^15.17.0 → ^15.18.1 - globals: ^17.6.0 → ^17.7.0 - jest-fetch-mock: ^3.0.3 → ^4.2.0 - ts-loader: ^9.6.1 → ^9.6.2 - webpack: ^5.107.2 → ^5.108.4 - webpack-cli: ^7.0.3 → ^7.2.1 Skipped due to peer dependency conflicts: - typescript (7.x incompatible with typescript-eslint 8.x) - eslint (10.x incompatible with eslint-plugin-react 7.x)
Create React Component Library
This project aims to have a starter kit for creating a new React Library with storybook.
Setup
To create a new project run in the terminal:
npx @aleleba/create-react-component-library react-library
Then run:
cd react-library
You will need to create a new .env file at the root of the project for global config. This is an exaple of config.
#Library Name (Default: ui-library)
LIBRARY_NAME=ui-library
#External CSS (Default: false)
EXTERNAL_CSS=true
#External CSS NAME (Default: index.css)
EXTERNAL_CSS_NAME=other_name.css
#PREFIX URL (Default: '')
PREFIX_URL=
For Development
In the terminal run:
npm run start
You will find the components on:
scr/components
You will find stories of storybook on:
scr/stories
This will start the app-library in development mode, also it have Hot Reloading! Enjoy coding!
For Production
In the terminal run:
npm run build
It will create a dist folder and run:
npm publish
This will publish on npm your package.
Cheers
Hope you enjoy this proyect! Sincerely Alejandro Lembke Barrientos.