kbase-ui - a KBase User Interface

About

The KBase User Interface (kbase-ui) is a web browser Single Page App (SPA) providing tools for KBase users. It is one of several user-facing interfaces at KBase.

kbase-ui has traditionally served as a container for various "plugins" which provide most of the functionality of the interface. The current set of plugins may be found in the plugins config.

Some examples include:

• 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.

More recently functionality has been added directly to the kbase-ui codebase, including:

• User Profile, for viewing any user profile and editing their own,
• KBASE ORCID Link, for creating a link between a KBase account and ORCID account.

Intended Audience

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.

If you have stumbled up on this project, you may first want to find out about KBase. The KBase UI is not a general purpose tool -- it is designed to work inside the KBase ecosystem.

Documentation

Generally, see the internal documentation.

Quick starts are a great place to ... start!

• Deployment
• Development

Contributing

The KBase UI is an open source project, managed through GitHub. Generally this is maintained by KBase staff, through feature or fix branches which are then incorpporated through a Pull Request process.

Release Notes

The current released version is 3.x.x.

Reporting Bugs

We do not currently use GitHub issues for bug reports. Please visit KBase Support for bug reports, questions or feature requests.

License

LICENSE.md