mirror of
https://github.com/aleleba/create-react-component-library.git
synced 2026-07-04 06:11:20 -06:00
Alejandro Lembke Barrientos
9223b1e144
Add tsconfig.cy.json that extends the main tsconfig but removes the rootDir restriction and adds Cypress types. Point ts-loader in webpack.cy.config.ts to this dedicated tsconfig, fixing: - TS6059: cypress/support files outside rootDir src/components - TS2307: missing @storybook/react-webpack5 type declarations - TS2339: toBeInTheDocument not found (jest-dom types scope)
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.