aleleba/react-list-ui-library
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
React list ui library for conference.
3 Commits 1 Branch 0 Tags 405 KiB
TypeScript 68.3%
MDX 15.1%
SCSS 9.7%
JavaScript 6.1%
HTML 0.8%
77935d20b9
Go to file
Alejandro Lembke Barrientos 77935d20b9 PR-722301: Adding Button Test.
2023-10-11 23:24:42 +00:00
.github/workflows PR-722301: Adding Library Components. 2023-10-11 23:15:46 +00:00
.storybook PR-722301: Adding Library Components. 2023-10-11 23:15:46 +00:00
cypress Initial commit 2023-10-11 01:58:04 +00:00
src PR-722301: Adding Button Test. 2023-10-11 23:24:42 +00:00
.babelrc Initial commit 2023-10-11 01:58:04 +00:00
.env.example Initial commit 2023-10-11 01:58:04 +00:00
.eslintrc.js Initial commit 2023-10-11 01:58:04 +00:00
.gitignore Initial commit 2023-10-11 01:58:04 +00:00
cypress.config.ts Initial commit 2023-10-11 01:58:04 +00:00
jest.config.js Initial commit 2023-10-11 01:58:04 +00:00
LICENSE Initial commit 2023-10-11 01:58:04 +00:00
package-lock.json PR-722301: Adding Library Components. 2023-10-11 23:15:46 +00:00
package.json PR-722301: Adding Library Components. 2023-10-11 23:15:46 +00:00
PRNameGenerator.ts Initial commit 2023-10-11 01:58:04 +00:00
README.md Initial commit 2023-10-11 01:58:04 +00:00
setupTest.ts Initial commit 2023-10-11 01:58:04 +00:00
tsconfig.json PR-722301: Adding Library Components. 2023-10-11 23:15:46 +00:00
webpack.config.ts Initial commit 2023-10-11 01:58:04 +00:00
webpack.cy.config.ts Initial commit 2023-10-11 01:58:04 +00:00

README.md

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.