create-react-component-library/README.md

56 lines
1.1 KiB
Markdown
Raw Normal View History

# 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
2023-06-27 08:58:24 -06:00
#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.