splunk / addonfactory-ucc-base-ui

The base UI for Splunk UCC based Add-on user interfaces

🚫DEPRECATION NOTICE 🚫

As of October 4, 2023, this repository has been deprecated.

The contents of this repository have been merged into the backend repository addonfactory-ucc-generator under the ui subfolder. All future updates, issues, pull requests, and other activities related to this repo will be managed there.

Please refer to the addonfactory-ucc-generator repository for the latest version and updates.

Contributing to UCC UI Library

Overview

The project contains UI framework that renders UI components dynamically based on provided globalConfig.json.

Getting Started

1. Clone the repo.
2. Install yarn (>= 1.2) if you haven't already: npm install --global yarn.
3. Run the setup task: yarn run setup.

After this step, the following tasks will be available:

• yarn run build – Create a production bundle
• yarn run start – build bundle and watch changes
• yarn run storybook - start storybook and open http://localhost:6006
• yarn run eslint – Run linters
• yarn run eslint:fix – Fixed the linters and run prettier
• yarn run format – Run prettier to auto-format *.js, *.jsx and *.css files. This command will overwrite files without asking, format:verify won't.

Running yarn run setup once is required to enable all other tasks. The command might take a few minutes to finish.

Communication channels

If you are a Splunker use: https://splunk.slack.com/archives/C03T8QCHBTJ

If you are a part of the community use: https://splunk-usergroups.slack.com/archives/C03SG3ZL4S1

Code Formatting

UCC UI Lib uses prettier to ensure consistent code formatting. It is recommended to add a prettier plugin to your editor/ide.