Skip to content

kevjustice/HomepageSidecar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Homepage Helper (Sidecar) 🚀

A powerful, visual configuration UI for the gethomepage/homepage dashboard.

Homepage Helper acts as a "Sidecar" to your Homepage instance, allowing you to manage services, bookmarks, widgets, and raw configuration files through a modern, responsive web interface.

✨ Features

  • Visual Board: Organize your services with drag-and-drop reordering and compact, dense card layouts.
  • Tree Editor: Manage nested groups and hierarchy with ease.
  • Widget Catalog: Discover and configure information widgets with direct template support.
  • Expert Mode: Direct YAML access for power users with real-time preview.
  • Custom Branding: Fully dark-mode themed with a premium UI.

🚀 Getting Started

Prerequisites

  • Docker and Docker Compose
  • An existing Homepage installation

Installation

  1. Clone this repository:

    git clone https://github.com/kevjustice/HomepageSidecar.git
    cd HomepageSidecar
  2. Update your docker-compose.yml to include the helper service.

services:
  homepage-helper:
    build: .
    container_name: homepage-helper
    ports:
      - "8080:8080"
    volumes:
      - /path/to/your/homepage/config:/config
    environment:
      - BASIC_AUTH_USER=admin
      - BASIC_AUTH_PASS=password
    restart: unless-stopped
  1. Run docker compose up -d --build.
  2. Visit http://localhost:8080.

🛠 Tech Stack

  • Frontend: React, TypeScript, TailwindCSS, Vite, Lucide, Dnd-kit.
  • Backend: Fastify, Node.js, TypeScript, Zod.
  • Branding: Custom Minimalist UX.

⚠️ WARNING ⚠️

This application was built 100% using Google Antigravity I was able to craft it by developing a 15 page prompt (assisted by ChatGPT), and then fed this to Antigravity. That gave me the first working version and then I began tweaks and edits (by telling Antigravity what I wanted fixed) until I got to the current version. I am a developer, but I did not develop this app. I have not done a line-by-line review of the code. For the purpose of it editing just the config files for the Homepage App, this app should be fine and not cause any security concerns. However I would NOT expose it to the public web or give it any additional rights into Docker or anything else.

📜 License

Distributed under the MIT License. See LICENSE for more information.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.


Created with ❤️ by Kevin Justice

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages