https://github.com/hal/halos-console
halOS Console
https://github.com/hal/halos-console
Last synced: about 1 month ago
JSON representation
halOS Console
- Host: GitHub
- URL: https://github.com/hal/halos-console
- Owner: hal
- License: apache-2.0
- Created: 2022-11-25T10:31:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-11T19:02:57.000Z (over 2 years ago)
- Last Synced: 2025-01-07T05:47:46.498Z (over 1 year ago)
- Language: TypeScript
- Size: 1.31 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# halOS Console
halOS stands for **HAL** on **O**pen**S**hift. It is derived from [HAL](https://hal.github.io/) and allows monitoring and inspection of WildFly and other services running on OpenShift. Although the focus is on WildFly, halOS supports monitoring arbitrary services. This is achieved through the concept of capabilities and extensions.
## Architecture
halOS consists of two parts:
1. [Proxy](https://github.com/hal/halos-proxy) (back-end)
2. Console (front-end, this repository)
This repository contains the console. The console is a [RIA](https://en.wikipedia.org/wiki/Rich_web_application) / [SPA](https://en.wikipedia.org/wiki/Single-page_application) following the design guidelines from [PatternFly](https://www.patternfly.org/v4/). It consumes the REST API exposed by the [proxy](https://github.com/hal/halos-proxy).
## Technical Stack
- [TypeScript](https://www.typescriptlang.org/)
- [React](https://reactjs.org/)
- [PatternFly](https://patternfly.org)
## Build
```shell
npm install
npm run build
```
## Run
Please refer to the halOS [distribution](https://github.com/hal/halos-distribution#readme) about how to set up all services on OpenShift, start halOS and access the console.
## Development
Before starting the console in dev mode, make sure to start the [proxy](https://github.com/hal/halos-proxy) in [dev mode](https://github.com/hal/halos-proxy#development) as well. Then start the proxy in dev mode, using
```shell
npm run dev
```