Skip to content

Latest commit

 

History

History
57 lines (33 loc) · 4.08 KB

README.md

File metadata and controls

57 lines (33 loc) · 4.08 KB
Raw

Juno

REUSE status

Overview

Juno is a platform that includes tools and libraries for developing Juno-based applications. This platform provides a comprehensive set of utilities to streamline the development process, ensure consistency, and facilitate code sharing across different projects.

Key Components

  • Design System: The ui-components library offers a consistent set of UI components, styles, and guidelines for building user interfaces.
  • OIDC Library: Provides OpenID Connect (OIDC) support for authentication and authorization in Juno-based applications.
  • Communicator Library: Facilitates communication between different parts of the application, ensuring efficient data exchange.
  • CLI Tools: Command-line tools to generate, build, and manage applications and libraries, simplifying the development workflow.

Applications

Juno includes various applications that showcase the use of its tools and libraries, providing examples and templates for developers.

Included Applications

  • Supernova: an alternative Prometheus Alertmanager UI
  • Heureka: dashboard for security and compliance management
  • Doop: displays policy violations as reported by Gatekeeper
  • App template: an app template for Juno applications
  • Example app: an example application containing some best practice ux pattern examples (in progress)

Libraries

In addition to applications, Juno also includes a set of libraries that provide shared functionality and utilities across different parts of the system. These libraries are designed for reusability and modularity, facilitating consistent development practices and code sharing.

Included Libraries

  • Juno UI Components: React components for the Juno design system
  • k8s client: a client-side API client for the kubernetes API (interact with the k8s API directly from the browser)

Getting Started

To get started with Juno, follow the instructions in the Getting Started Guide. This guide covers the initial setup, installation of dependencies, and basic usage of the platform's tools and libraries.

Documentation

Comprehensive documentation for Juno is available in the docs directory. This includes detailed guides on using the various tools and libraries, best practices, and examples to help you get the most out of the platform.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports, etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2024-2026 SAP SE or an SAP affiliate company and Juno contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.