kbaseui/kbase-ui-paydown repository overview

⁠KBase User Interface

⁠Current Status

⁠About

The KBase User Interface (kbase-ui) is a web browser Single Page App (SPA) providing tools for KBase⁠ users. It is a partner to the KBase Narrative Interface⁠, with which it shares code yet runs as a separate web app. Current user features include:

• Dashboard, for an overview of a user's narratives and activities, and those of their colleagues
• User Profile, for viewing any user profile and editing their own,
• Data Viewer, for inspecting any data object a user has access to (aka "landing pages"),
• Type Viewer, for inspecting the attributes of any data type,
• Authenticator, for logging into and out of user's KBase Account and granting authorization to the web app,
• Catalog, for browsing, searching and (for developers) managing KBase Narrative Apps.

The primary audience for this project is

• KBase Developers and Staff - who need access to the kbase-ui for development, testing, deployment
• KBase Advanced Users - who are developing services and plugins for kbase-ui,
• KBase Contributors - who wish to know more about the architecture and "sausage making" of KBase.

Most KBase users will be exposed to the KBase UI by ... using KBase⁠ :)

⁠Documentation

• develop⁠ - Documentation available in the current develop branch of kbase-ui
• release⁠ - Documentation available in the current production release (will be available after the 1.7.0 is released)

⁠Contributing

The KBase UI is an open source project, managed through github. As such, contributions, even internally within KBase, are conducted through fork and PR.

⁠Release Notes

The current released version is 1.7.0⁠.

⁠Reporting Bugs

We do not currently use github issues for bug reports. Please send any bug reports, comments, or requests via our public help board⁠.

⁠License

LICENSE.md⁠