twlatx/startpage-dashboard repository overview

⁠🚀 Start Page Dashboard

A modern, customizable browser start page with category-based organization, service monitoring, and an admin interface.

⁠✨ Features

• 🎨 Modern Glassmorphism Design - Beautiful dark theme with animated gradients
• 📂 Categorized Blocks - Organize your links by category
• 🔤 Alphabetical Sorting - Blocks automatically sorted within each category
• 🖼️ Custom Icons - Support for custom images or auto-fetched favicons
• 📊 Service Monitoring - Monitor the health of your self-hosted services
• 🌤️ Weather Display - Show current weather with location search
• 🚗 Traffic Information - Real-time commute times with color-coded status
• ⚙️ General Settings - Customize site title and favicon
• 🔐 Security - 2FA/TOTP support, session management, rate limiting
• ⚡ Admin Interface - Web UI to manage all settings
• 🐳 Docker Ready - Easy deployment with Docker Compose
• ⌨️ Keyboard Shortcuts - Ctrl+K to focus search
• 📱 Responsive - Works on all devices

⁠🚀 Quick Start

⁠Using Docker Compose (Recommended)

The easiest way to run Start Page Dashboard is using the pre-built Docker image from Docker Hub.

1. Create a docker-compose.yml file:

version: '3.8'

services:
  startpage:
    image: twlatx/startpage-dashboard:latest
    container_name: startpage-dashboard
    ports:
      - "3000:3000"
    environment:
      - NODE_ENV=production
      - DATABASE_URL=file:/app/data/prod.db
      - NEXT_PUBLIC_APP_NAME=Start Page Dashboard
    volumes:
      - ./data:/app/data
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:3000/api/health"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 40s

1. Start the application:

docker-compose up -d

1. Open http://localhost:3000⁠ in your browser

2. Access the admin panel at http://localhost:3000/admin⁠

⁠📁 Project Structure

startpage-dashboard/
├── src/
│   ├── app/              # Next.js app router
│   │   ├── api/          # API routes
│   │   ├── admin/        # Admin interface
│   │   ├── globals.css   # Global styles
│   │   ├── layout.tsx    # Root layout
│   │   └── page.tsx      # Main dashboard
│   ├── components/       # React components
│   ├── lib/              # Utility functions
│   └── types/            # TypeScript types
├── prisma/
│   ├── schema.prisma     # Database schema
│   └── seed.ts           # Seed data
├── docker-compose.yml    # Docker Compose config
├── Dockerfile            # Docker image
└── README.md             # This file

⁠🔧 Configuration

⁠Adding Blocks

Visit /admin to manage blocks and categories through the web interface.

⁠Service Monitoring

When adding a block, you can enable monitoring by:

1. Checking "Is Monitored"
2. Providing a health check URL
3. The dashboard will show a status indicator

⁠Custom Icons

You can provide custom icon URLs when creating blocks. If no icon is provided, the dashboard will automatically fetch the website's favicon.

⁠🔌 API Endpoints

• GET /api/categories - List all categories with blocks

• POST /api/categories - Create a new category

• PUT /api/categories/:id - Update a category

• DELETE /api/categories/:id - Delete a category

• GET /api/blocks - List all blocks

• POST /api/blocks - Create a new block

• PUT /api/blocks/:id - Update a block

• DELETE /api/blocks/:id - Delete a block

• GET /api/health/:id - Check service health

⁠🐳 Docker Deployment

⁠Using Pre-built Image (Recommended)

Pull and run the official image from Docker Hub:

# Pull the latest image
docker pull twlatx/startpage-dashboard:latest

# Run with docker run
docker run -d \
  --name startpage-dashboard \
  -p 3000:3000 \
  -v ./data:/app/data \
  -e NODE_ENV=production \
  -e NEXT_PUBLIC_APP_NAME="Start Page Dashboard" \
  --restart unless-stopped \
  twlatx/startpage-dashboard:latest

⁠Building from Source

docker-compose up -d --build

⁠View logs:

docker-compose logs -f

⁠Stop:

docker-compose down

⁠Data persistence:

The SQLite database is stored in ./data/prod.db and persisted through Docker volumes.

⁠🛠️ Tech Stack

• Next.js 15⁠ - React framework
• TypeScript⁠ - Type safety
• Tailwind CSS⁠ - Styling
• Prisma⁠ - Database ORM
• SQLite⁠ - Database
• Lucide React⁠ - Icons

⁠📝 License

MIT License - feel free to use this project for personal or commercial purposes.