https://github.com/42bytelabs/konarr-client

Konarr Frontend Client
https://github.com/42bytelabs/konarr-client

Last synced: 5 months ago
JSON representation

Konarr Frontend Client

• Host: GitHub
• URL: https://github.com/42bytelabs/konarr-client
• Owner: 42ByteLabs
• License: apache-2.0
• Created: 2024-08-10T11:21:50.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-11-26T23:39:17.000Z (7 months ago)
• Last Synced: 2025-11-29T18:17:51.711Z (7 months ago)
• Language: Vue
• Size: 639 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          



Konarr Frontend Client


[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]

[![Crates.io Version](https://img.shields.io/crates/v/konarr?style=for-the-badge)][crates-io]

[![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/konarr?style=for-the-badge)][crates-io]

[![GitHub Stars](https://img.shields.io/github/stars/42ByteLabs/konarr?style=for-the-badge)][github]

[![GitHub Issues](https://img.shields.io/github/issues/42ByteLabs/konarr-client?style=for-the-badge)][github-issues]

[![Licence](https://img.shields.io/github/license/42ByteLabs/konarr?style=for-the-badge)][license]

⚠️  This is currently a work in progress and still in the early stages of development ⚠️



## Overview

[Konarr][konarr] is a simple, easy-to-use web interface for monitoring your servers, clusters, and containers for supply chain attacks.

It is designed to be lightweight and fast, with minimal resource usage.

This repository contains the client-side code for [Konarr][konarr].

## 🚀 Local Development

To run the client locally, you will need to have the following installed:

- [Node.js][node] & [npm][npm]

Once you have the above installed, you can run the following commands:

```bash

npm install

```

This will install all the required dependencies.

To start the development server, run:

```bash

npm run dev

```

This will start the development server on `http://localhost` and you can access the client from your browser.

### 🌐 Setting up the Server

To access a Konarr Server instance, you will need to have the [Konarr Server][github] running.

Checkout the [Konarr Server][github] repository for more information on how to run the server.

You can set the server URL by creating a `.env` file in the root of the project and adding the following:

```env

VITE_SERVER_BASE_URL=http://localhost:8000/api

```

Replace `http://localhost:8000/api` with the URL of your server.

## ✨ Components

Here is the core components used by Konarr:

- [VueJS][vue]

- [Tailwind][tailwind]

- [Material Design Icons (MDI)][mdi]

- [Heroicons][heroicons]

- [HeadlessUI][headlessui]

## ❤️  Maintainers / Contributors

  

    

      
Mathew Payne
💻 👀

    

  

## 🦸 Support

Please create [GitHub Issues][github-issues] if there are bugs or feature requests.

This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.

## 📓 License

This project is licensed under the terms of the Apache2 open source license.

Please refer to [Apache2][license] for the full terms.

[license]: ./LICENSE

[crates-io]: https://crates.io/crates/konarr

[docs]: https://docs.rs/konarr/latest/konarr

[semver]: https://semver.org/

[konarr]: https://github.com/42ByteLabs/konarr

[github]: https://github.com/42ByteLabs/konarr-client

[github-issues]: https://github.com/42ByteLabs/konarr-client/issues

[vue]: https://vuejs.org/

[node]: https://nodejs.org/

[tailwind]: https://tailwindcss.com/

[mdi]: https://pictogrammers.com/library/mdi/

[heroicons]: https://heroicons.com/

[headlessui]: https://headlessui.com/v1/vue