mirror of
https://github.com/aleleba/create-react-component-library.git
synced 2026-07-04 06:11:20 -06:00
Alejandro Lembke Barrientos
62dd7186c1
- Remove 'cypress' from types array: Cypress ships its own types, not via @types/cypress — the /// <reference types="cypress" /> in support files resolves them correctly without this entry. - Exclude *.stories.* and *.test.* from the program: ts-loader does full program type-checking, pulling in stories (@storybook types unavailable) and Jest tests (@testing-library/jest-dom not in scope). These files are irrelevant to Cypress.
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.