Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 2.17 KB

README.md

File metadata and controls

41 lines (29 loc) · 2.17 KB
Raw

commons-ui

Library for sharing GridSuite apps commons components

For developers

The commons-ui library have a demo app in which you can call your components to test them. The npm start command install the library's dependencies then launches the demo app.

If you want to test your library integration with a consumer application my-app you have first to build commons-ui via npm run build then change the commons-ui dependency in my-app's package.json from @gridsuite/commons-ui:"^x.x.x" to @gridsuite/commons-ui:"file:../path/to/the/commons-ui" then type npm install npm start.

For integrators

If you want to deploy a new version of commons-ui in the NPM package registry, you need to follow the steps below:

  • Update to the new version in package.json (example 0.6.0)
  • Build it: npm install
  • Commit the package.json and package-lock.json files, push to a branch, make a PR, have it reviewed and merged to main.
  • Pull and checkout main on your last commit.
  • Tag your last commit : git tag <tag> (example: v0.6.0)
  • Push tag : git push origin <tag>
  • Checkout the tag in a fresh repo copy : cd $(mktemp -d) && git clone https://github.com/gridsuite/commons-ui.git then cd commons-ui && git checkout <tag>
  • Test your package: npm install
  • Login on the command line to the npm registry: npm login
  • Publish the package: npm publish

License Headers and dependencies checking

To check dependencies license compatibility with this project one locally, please run the following command :

npm run licenses-check

Notes :

  • Check license-checker-config.json for license white list and exclusion. If you need to update this list, please inform organization's owners.