https://github.com/mel3kings/saas-utils
npm package library
https://github.com/mel3kings/saas-utils
Last synced: 5 months ago
JSON representation
npm package library
- Host: GitHub
- URL: https://github.com/mel3kings/saas-utils
- Owner: mel3kings
- License: mit
- Created: 2024-03-01T14:24:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-01T15:59:14.000Z (over 1 year ago)
- Last Synced: 2024-08-03T22:24:31.663Z (about 1 year ago)
- Language: JavaScript
- Size: 353 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mel3kings/saas-utils - npm package library (JavaScript)
README
# 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.