This repository contains the Strimzi UI and its implementation. Strimzi UI provides a way for managing Strimzi and Kafka clusters (+ other components) deployed by it using a graphical user interface.
This UI uses npm to provide dependency management. If you wish to develop the UI, you will need:
Once these prerequisites are met, all required dependencies to build and run the UI can be downloaded by running the following command:
npm install
If you run into any issues while working in this repo, please check out the troubleshooting guide.
npm scripts are provided for common tasks. These include:
npm run start- runs the UI in development modenpm run build- builds the UInpm run clean- deletes the build/generated content directoriesnpm run lint- lints the codebase. SeeLintingfor the individual linting steps
Further details around how this UI is implemented can be found below:
When making a commit, your commit message may look as follows:
feat: new feature
- adds feature X
Signed-off-by: Matthew <matthew@domain>
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# Date: <date>
#
# On branch X
# Changes to be committed:
# modified: file
but this is rejected by commitlint:
husky > commit-msg (node v10.15.0)
⧗ input: feat: new feature
- adds feature X
Signed-off-by: Matthew <matthew@domain>
✖ message must be signed off [signed-off-by]
✖ found 1 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
This is due to this bug, where comments are parsed/not ignored. While this issues exists, you can work around this by removing all comments from your message, ie:
feat: new feature
- adds feature X
Signed-off-by: Matthew <matthew@domain>