Skip to content

ferrumc-rs/dashboard

Repository files navigation

FerrumC Header

License Code Size SvelteKit Discord


⚡ Integrated by Default

Important

No installation needed. This dashboard is natively served by the FerrumC Rust binary. This repo is only for UI development and contribution.


✨ Features

  • 🛰️ Real-time: Persistent bi-directional WebSocket connection.
  • 📊 Live Stats: Instant server metrics, logs, and player counts.
  • 🎮 Remote Console: Full command execution from your browser.
  • 📱 Responsive: Fully optimized for Mobile and Desktop management.

🖼️ Gallery

Desktop View Mobile View
Desktop and Mobile interfaces synced via WebSockets.

🛠️ Developer Quickstart

If you want to contribute to the UI or run a custom dev environment:

# 1. Setup
pnpm i

# 2. Run Dev (Connects to local FerrumC)
pnpm dev

# 3. Build (Outputs to ./build)
pnpm build

Tip

Custom Instance: To link the dashboard to a specific server, append the port to the URL: localhost:5173/?ws_port=9000


🔄 Automated Workflow

  1. Push: Changes committed to the master branch.
  2. Build: GitHub Actions automatically bundles the SvelteKit application.
  3. Release: Build artifacts are packaged and uploaded to GitHub Releases.
  4. Sync: The FerrumC binary fetches the latest UI assets to serve them natively.

Built with ❤️ by the FerrumC TeamJoin Discord

About

The server dashbord/admin panel for ferrumc.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •