Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iggy-rs/iggy-web-ui

Web UI management panel for Iggy.rs message streaming.
https://github.com/iggy-rs/iggy-web-ui

iggy ui web

Last synced: 3 days ago
JSON representation

Web UI management panel for Iggy.rs message streaming.

Host: GitHub
URL: https://github.com/iggy-rs/iggy-web-ui
Owner: iggy-rs
License: mit
Created: 2023-07-20T14:07:43.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-08-29T13:53:02.000Z (3 months ago)
Last Synced: 2024-08-29T15:25:19.137Z (3 months ago)
Topics: iggy, ui, web
Language: Svelte
Homepage:
Size: 1.7 MB
Stars: 44
Watchers: 2
Forks: 9
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Iggy Web UI

This repository hosts the web user interface for [Iggy](https://github.com/spetz/iggy), a persistent message streaming platform written in Rust. The web UI is built using SvelteKit.

![iggy](static/signIn.png)

![iggy](static/stats.png)

![iggy](static/permissions.png)

![iggy](static/streams.png)

![iggy](static/streamsLight.png)

## Overview

The Iggy Web UI provides a user-friendly panel for managing various aspects of the Iggy platform, including streams, topics, partitions, and more.

### Getting Started

1. **Run Iggy server first**

   ```sh

   docker pull iggyrs/iggy:latest

   ```

   ```sh

   docker run -p 3000:3000 -p 8090:8090 iggyrs/iggy:latest

   ```

1. **Clone the repository:**

   ```sh

   git clone https://github.com/iggy-rs/iggy-web-ui.git

   ```

1. **Build the project:**

   ```sh

   cd iggy-web-ui

   npm install

   ```

1. **Run the project:**

   ```sh

   npm run dev

   ```

   **To expose port in local network run:**

   ```sh

   npm run dev -- --host --port 3333

   ```

   **If Iggy server was run using cargo directly we need to change PUBLIC_IGGY_API_URL env in web ui root folder to:**

   ```sh

   PUBLIC_IGGY_API_URL=http://0.0.0.0:3000

   ```

   **instead of**

   ```sh

   PUBLIC_IGGY_API_URL=http://localhost:3000

   ```

## Roadmap

- [x] Authorization

- [x] Allow manual interval setting for auto-refresh

- [x] Introduce dark mode

- [x] Enable CRUD operations on Streams

- [x] Enable CRUD operations on Topics

- [ ] Messages management

- [ ] General UI improvements

- [ ] Permission management (in progress)

- [ ] GitHub actions CI/CD

- [ ] Publish to Dockerhub as separate Image

## Contributing

Feel free to contribute to the project. Your feedback and contributions are highly appreciated!