Skip to content

brimmasch/minecraft-status

Repository files navigation

Minecraft Status Dashboard

A modern Minecraft server status website built with Vite, React, TypeScript, Tailwind, and shadcn-style UI components.

Stack

  • Vite
  • React
  • TypeScript
  • Tailwind CSS
  • shadcn-style component setup
  • Docker / Docker Compose

Run in Docker (recommended)

From the project root:

docker compose up --build -d

App URL:

Useful commands:

# Follow logs
docker compose logs -f web

# Stop
docker compose down

# Rebuild after dependency/config changes
docker compose up --build -d

Server Configuration

Edit server entries in:

  • src/data/servers.json

Each server uses this shape:

{
  "id": "survival",
  "name": "Emerald Survival",
  "address": "play.example.net",
  "description": "Community-focused survival world.",
  "artwork": "crystal"
}

Fields

  • id: unique string key
  • name: display name
  • address: Minecraft server hostname queried for status
  • description: card subtitle
  • artwork: one of crystal, neon, sunset

A starter template is available at src/data/servers.sample.json — copy it to servers.json and replace the addresses with your own:

cp src/data/servers.sample.json src/data/servers.json

Notes

  • The UI fetches status from https://api.mcsrvstat.us/2/<address>.
  • Status auto-refreshes every 60 seconds.
  • Manual refresh is available via the Refresh Status button.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors