@percona/platform-core

Platform UI core components

Usage no npm install needed!

<script type="module">
  import perconaPlatformCore from 'https://cdn.skypack.dev/@percona/platform-core';
</script>

README

Percona Enterprise Platform Core UI

Local development

In order to setup the local development environment please run the following commands:

    npm i
    npm start

Publishing

  • Log in to the registry: npm login
  • You need to have valid npm credetials set up (npm whoami should return your npm username)
  • Checkout the main branch
  • Run: npm run lint && npm run build
  • Double check that the dist directory was created and contains a build
  • Update the version: npm version patch|minor|major (this will create a new tag and update package.json accordingly)
  • Push the tags: git push --follow-tags (this will push the updated package.json to main with the new tag)
  • Publish the new version: npm publish --tag latest --access public
  • To publish a dist-tag: npm publish --tag next --access public
  • To remove a dist-tag: npm dist-tag rm @percona/platform-core next

The published package name is @percona/platform-core.

Important

  • This project does not leverage imports through static paths because tsc does not properly support them when generating types.

Challenges

  • Currently we are unable to use direct imports, because the build system does not properly handle them in the bundle. This is possible however, but would require a more complicated build config.