Skip to content

AuroraMirror/aurora-dashboard

Repository files navigation

AURora Dashboard

A real-time monitoring dashboard for AURora cache servers. Built with Next.js 15, TypeScript, and Tailwind CSS.

What it does

  • Live monitoring of AURora cache server stats
  • Package tracking - see which packages are being fetched most
  • Real-time updates with manual refresh capability
  • Mobile responsive with hamburger navigation
  • Configurable via environment variables

Quick start

git clone <your-repo>
cd aurora-dashboard
npm install
cp config.example.env .env.local
# Edit .env.local with your Aurora server URL
npm run dev

Configuration

Copy config.example.env to .env.local and set:

# Your AURora server (the cache server you're monitoring)
NEXT_PUBLIC_AURORA_SERVER_URL=http://localhost:8080

# Where this dashboard will be hosted
NEXT_PUBLIC_DASHBOARD_URL=http://localhost:3001

# Canonical URL for SEO
NEXT_PUBLIC_CANONICAL_URL=https://your-domain.com

Development

npm run dev          # Start dev server
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint

Tech stack

  • Next.js 15 - App Router, API routes
  • TypeScript - Type safety
  • Tailwind CSS 4 - Styling
  • Lucide React - Icons
  • Recharts - Data visualization

Project structure

src/
├── app/                    # Next.js App Router
│   ├── api/               # API routes
│   ├── components/        # Reusable components
│   ├── faq/              # FAQ page
│   └── layout.tsx        # Root layout
├── config/                # Configuration
└── types/                 # TypeScript types

API endpoints

The dashboard expects your AURora server to have a /stats endpoint that returns:

{
  "totalPackages": 1234,
  "totalFetches": 5678,
  "cacheSize": "2.3 GB",
  "mostFetched": [
    {
      "name": "package-name",
      "fetch_count": 42
    }
  ],
  "mostRequested": [
    {
      "name": "package-name",
      "request_count": 15
    }
  ]
}

Deployment

Vercel (recommended)

  • Push to GitHub
  • Connect repo to Vercel
  • Set environment variables
  • Deploy

Other platforms

  • Build with npm run build
  • Deploy out/ directory
  • Set environment variables

Contributing

  1. Fork the repo
  2. Create a feature branch
  3. Make your changes
  4. Test locally
  5. Submit a PR

License

GPL 3.0

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published