Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CALM UI/UX Hack Day #610

Open
YoofiTT96 opened this issue Nov 21, 2024 · 0 comments
Open

CALM UI/UX Hack Day #610

YoofiTT96 opened this issue Nov 21, 2024 · 0 comments

Comments

@YoofiTT96
Copy link

YoofiTT96 commented Nov 21, 2024

Related to #300
When: Friday 22nd November 2024
Where: Zoom

Description
We need to develop a user interface (UI) that will enable users to interact with and visualize CALM schemas more intuitively. This UI should present the schema's structure in a user-friendly manner, allowing users to easily navigate through nested objects, arrays, and other complex data types. The goal is to simplify the understanding and manipulation of CALM, making it accessible even to those with limited technical expertise.

Features
Schema Visualization: Implement a tree-like visualization to display the hierarchical structure of the CALM schema. This should include collapsible and expandable nodes for nested elements.

Schema Editor: Provide an interactive editor where users can modify the schema. This editor should support drag-and-drop functionality for reorganizing elements, along with validation to ensure the schema remains compliant with CALM schema standards.

Domain Editor: Provide an interactive editor where users can manage domains. This editor should support drag-and-drop functionality for reorganizing elements, along with validation to ensure the schema remains compliant with CALM schema standards.

Documentation and Help: Integrate tooltips and a help section to guide users through the various features and functionalities of the UI. This should include explanations of CALM schema concepts and common use cases.

Benefits
Creating a UI for CALM will significantly enhance the user experience by providing a clear and interactive way to visually manage. It will reduce the complexity associated with manually editing CALM files and help prevent errors by ensuring that changes are valid in real-time. Additionally, this feature will make CALM schemas more accessible to non-developers, fostering better collaboration across different teams within the organization.

CALM CLI main focus areas to keep in mind for translation to the UI: Generate, Visualise, Validate
Hack day work will revolve around the visualize component

Workflow
Create a fork of this repo and create a branch off the vizualizer branch
**Note that you need to fork the repo with all branch by unchecking the option "fork only main branch" **

Completed work based on merged PRs
#487
#568
#570
#564

Ongoing work based on open PRs
#597

**Pending work based off #487 **
#613
#614
#615
#620
#621

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant