React list ui library for conference.

Go to file

Alejandro Lembke Barrientos 3af199e044 Merge pull request #5 from aleleba/PR-883221 PR-883221: changing the right color for the button design.		2023-10-16 08:43:22 -06:00
.github/workflows	PR-722301: Adding Input and List Components testing.	2023-10-12 00:08:05 +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-883221: changing the right color for the button design.	2023-10-16 14:37:59 +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-883221: changing the right color for the button design.	2023-10-16 14:37:59 +00:00
PRNameGenerator.ts	Initial commit	2023-10-11 01:58:04 +00:00
README.md	PR-320700: Fixing Readme title.	2023-10-12 06:43:52 +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

React List UI Library

This project is a React Library with storybook for a List App.

Setup

First clone the repo:

git clone git@github.com:aleleba/react-list-ui-library.git

Then run:

cd react-list-ui-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.