0.4.5 • Published 4 years ago

@vgs/vgs-elemente v0.4.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

VGS-ELEMENTE

Reusable UI Components Library

Install dependencies

npm i

Storybook for local development

npm run storybook

npm link usage for local development

  • in the this vgs-elemente root folder do:

    npm link
  • go to you app (e. g., dashboard) root folder and do:

    npm link vgs-elemente

    this must overwrite your vgs-elemente npm package from your app's node_modules folder with this vgs-elemente project.

    if this command didn't overwrite vgs-elemente npm package, then just delete it temporary.

  • in this vgs-elemente project's terminal you can run npm run build-watch, so it can trigger rebuild on every file save.

  • in the app project run npm start to start local development.
  • with this setup, every new changes with file save in this vgs-elemente project, hot-reload in your app project must be triggered.

Notes/Issues

Importing some react functional components while using npm link may lead to Invalid hook call error. In that case try linking this vgs-elemente project to the same React instance as your app using. From this project's terminal do:

npm link path/to/app/node_modules/react

Rebuild everything if needed and try again.

Publishing new version of npm package

  • After you done with all the changes do:
    npm run patch
  • Commit all changes.
  • Create new Pull Request to develop. Check it and merge.

Build component library

npm run build

Notes