mirror of
https://github.com/aleleba/create-react-component-library.git
synced 2025-01-07 12:21:21 -06:00
A starter kit for create a React component Library with storybook
|
|
||
|---|---|---|
| .github/workflows | ||
| .storybook | ||
| bin | ||
| cypress | ||
| src | ||
| .babelrc | ||
| .env.example | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmrc | ||
| cypress.config.ts | ||
| jest.config.js | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| PRNameGenerator.ts | ||
| README.md | ||
| setupTest.ts | ||
| tsconfig.json | ||
| webpack.config.ts | ||
| webpack.cy.config.ts | ||
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.