MayaTheShy/Homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove detailed project description and links from Home.md, retaining only the welcome message.

MayaChat
2026-02-02 21:51:42 -05:00
parent 46866fd2de
commit f3ae021d59
1 changed files with 1 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
Home.md

@@ -1,50 +1 @@
# Services Homepage — Project Wiki
This wiki provides documentation for the Services Homepage project: a lightweight static dashboard that lists and gives quick access to your self-hosted services. It also includes the tools used to monitor service health (via proxied checks), persist UI ordering, and enable PWA installation for mobile devices.
## What this project includes
- A responsive dashboard that renders service groups and individual service cards
- Health check proxy and small order-persistence API (Flask + SQLite)
- Drag-and-drop ordering with server-side persistence and localStorage caching
- Collapsible groups, themes, export/import of config, and dashboard widgets
- 3D animated background with FPS-aware fallback and PWA support
- Documentation and implementation notes collected in this wiki
## Scope
This repository is intended to host the static frontend, small supporting backend services (packaged as containers) and documentation. It is not a full orchestration platform — it assumes you will run the containers with Docker Compose and provide any TLS/HTTPS termination and reverse proxy (for example, Caddy/Nginx or an external gateway). The project focuses on usability, small-footprint services, and local-first operation with optional remote access.
## Quick links
- [Main README](README.md) — Overview, getting started and deployment
- [FAQ](FAQ.md) — Short answers and quick commands
- [Features](FEATURES.md) — High-level feature list and rationale
- [Quick Reference](QUICK-REFERENCE.md) — Common commands and tips
- [Order persistence](ORDER-PERSISTENCE.md) — Database layout and API
- [Implementation notes](IMPLEMENTATION-SUMMARY.md) — Architecture and design decisions
## How to contribute
1. Edit files in this wiki or the main repository.
2. If you're updating documentation, edit the corresponding markdown file here and push to this wiki repo.
3. To update the main repo's submodule pointer after changing the wiki:
```bash
cd services-homepage/wiki
git add .
git commit -m "Update wiki content: <short description>"
git push origin main
cd ..
git add wiki
git commit -m "Update wiki submodule reference"
git push origin main
```
## Support
If you run into issues with health checks, mixed-content (HTTP vs HTTPS), or PWA installation, check the relevant docs first (see Quick links above). If the problem persists, open an issue in the main repo or reach out via the project's issue tracker.
---
_This wiki file is managed as a git submodule (`wiki/`) in the main repository._
Welcome to the Wiki.