Skip to content

Commit

Permalink
chore(docs): adds links to apps to README (#350)
Browse files Browse the repository at this point in the history
  • Loading branch information
edda authored Sep 12, 2024
1 parent 84b90bc commit 732a05b
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Overview

Juno has evolved into 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.
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

Expand All @@ -21,18 +21,20 @@ Juno includes various applications that showcase the use of its tools and librar

#### Included Applications

- `apps/example`
- `apps/template`
- [Supernova](https://github.com/cloudoperators/juno/tree/main/apps/supernova): an alternative Prometheus Alertmanager UI
- [Heureka](https://github.com/cloudoperators/juno/tree/main/apps/heureka): dashboard for security and compliance management
- [Doop](https://github.com/cloudoperators/juno/tree/main/apps/doop): displays policy violations as reported by Gatekeeper
- [App template](https://github.com/cloudoperators/juno/tree/main/apps/template): an app template for Juno applications
- [Example app](https://github.com/cloudoperators/juno/tree/main/apps/example): 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

- `packages/ui-components`
- `packages/communicator`
- `packages/oauth`
- [Juno UI Components](https://github.com/cloudoperators/juno/tree/main/packages/ui-components): React components for the Juno design system
- [k8s client](https://github.com/cloudoperators/juno/tree/main/packages/k8s-client): a client-side API client for the kubernetes API (interact with the k8s API directly from the browser)

## Getting Started

Expand Down

0 comments on commit 732a05b

Please sign in to comment.