JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q39994F
  • License MIT

A starter kit for create a React component Library with storybook

Package Exports

  • qg-components
  • qg-components/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (qg-components) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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.