This project is a monorepo that packages shared config files, Vue components, CSS files, utilities, etc. that can be used for the frontend of all KNIME web projects.
A demo of all contained UI components, icons, CSS colors etc. can be found here: https://knime.github.io/webapps-common/
Please see the published packages on npm as well as the packages/
folder to access the relevant files and directories.
The demo application also serves as a development environment (code lives in demo/
folder)
cd demo
You must install the dependencies only with pnpm
pnpm install
and can be run locally by calling
pnpm dev
When committing your changes, a couple of commit hooks will run via husky.
-
pre-commit
hook to lint and format the changes in your stage zone (via lintstaged) -
prepare-commit-msg
hook to format your commit message to conform with the required format by KNIME. In order for this to work you must set environment variables with your Atlassian email and API token. Refer to@knime/eslint-config/scripts/README.md
for more information.
Every PR must include changeset file(s) out of which the CHANGELOG file of each package will get generated. Use the following command to create such files:
pnpm run changeset
When all changes are made and the package(s) should get published to npm:
-
run the following command to bump versions and create the actual changelog entries
pnpm run changeset:version
-
Push the changes to the PR
-
Hit the "Deploy" button in the Bitbucket Pipeline
-
Finally, merge the PR.