Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

docs(14): Complete GitHub & Community Links phase

Juan Denis170a78aa7c5c
diff --git a/.planning/ROADMAP.md b/.planning/ROADMAP.md
index 64bb3456..3a3d5331 100644
--- a/.planning/ROADMAP.md
+++ b/.planning/ROADMAP.md
@@ -25,7 +25,7 @@ Completed 2026-01-19 | 9 phases | 109 commits | +14,667/-2,836 lines
| 11 | Shared Database WordPress Template | pending | Create WordPress template with external DB support |
| 12 | Multi-Environment App Linking | pending | Link prod/dev apps to share database |
| 13 | Environment Switching UI | pending | UI to manage prod/dev environments |
-| 14 | GitHub & Community Links | pending | Add GitHub link, community resources to app |
+| 14 | GitHub & Community Links | **completed** | Add GitHub link, community resources to app |
| 15 | WordPress Dev Workflow Testing | pending | End-to-end testing of the dev workflow |
---
diff --git a/.planning/STATE.md b/.planning/STATE.md
index 0ecb084d..5cd5904b 100644
--- a/.planning/STATE.md
+++ b/.planning/STATE.md
@@ -13,9 +13,17 @@
| 11 | pending | - | - |
| 12 | pending | - | - |
| 13 | pending | - | - |
-| 14 | pending | - | - |
+| 14 | completed | 2026-01-19 | 2026-01-19 |
| 15 | pending | - | - |
+## Phase 14 Summary
+GitHub & Community Links fully implemented:
+- Updated About section with correct GitHub repository links
+- Added version update check via GitHub releases API (1-hour cache)
+- Added GitHub link to sidebar
+- Added dismissible "Star on GitHub" prompt for new users
+- All icons now use Lucide React components
+
## Milestone 2 Overview
Multi-Environment WordPress & Community Features (v1.1)
@@ -31,9 +39,11 @@ None currently identified.
## Notes
- Milestone 1 (v1.0) completed 2026-01-19
- Phase numbering continues from Milestone 1 (11-15)
-- Phase 14 (GitHub Links) can be done independently of 11-13
+- Phase 14 (GitHub Links) completed independently of 11-13
+- Next: Phase 11 (Shared Database WordPress Template)
## Quick Links
- [ROADMAP.md](./ROADMAP.md)
- [PROJECT.md](./PROJECT.md)
- [Milestone 1 Archive](./milestones/v1.0-ROADMAP.md)
+- [Phase 14 Summary](./phases/14-github-community-links/SUMMARY.md)
diff --git a/.planning/phases/14-github-community-links/SUMMARY.md b/.planning/phases/14-github-community-links/SUMMARY.md
new file mode 100644
index 00000000..cbe282e1
--- /dev/null
+++ b/.planning/phases/14-github-community-links/SUMMARY.md
@@ -0,0 +1,81 @@
+# Phase 14: GitHub & Community Links - Summary
+
+## Overview
+Added GitHub repository links and community resources throughout the application UI, including version update checking via the GitHub releases API.
+
+## Completed
+- [x] Task 1: Update About Section Links
+- [x] Task 2: Add Version Update Check
+- [x] Task 3: Add GitHub Link to Sidebar
+- [x] Task 4: Add Star Prompt for New Users
+
+## Implementation Details
+
+### About Section Links (Task 1)
+- Fixed GitHub URL from `github.com/serverkit` to `github.com/jhd3197/ServerKit`
+- Added Documentation link to README
+- Added Support & Issues link to GitHub Issues
+- Added Discussions link
+- Added Report a Bug link
+- Replaced all inline SVGs with Lucide icons (Github, FileText, HelpCircle, MessageSquare, Bug, Check, Layers)
+
+### Version Update Check (Task 2)
+**Backend** (`backend/app/api/system.py`):
+- Added `/system/check-update` endpoint
+- Fetches latest release from GitHub API (`api.github.com/repos/jhd3197/ServerKit/releases/latest`)
+- Compares versions using semver-like comparison
+- Returns: `current_version`, `latest_version`, `update_available`, `release_url`
+- 1-hour cache to respect GitHub API rate limits (60 req/hour unauthenticated)
+
+**Frontend**:
+- Added `checkUpdate()` API method
+- "Check for Updates" button in About section
+- Shows update notification with release link when available
+- Shows "You're up to date!" when current
+- Loading spinner while checking
+
+### Sidebar GitHub Link (Task 3)
+- Added GitHub icon link between nav container and user profile
+- Uses Lucide `Github` icon
+- Links to `github.com/jhd3197/ServerKit`
+- Hover effect matches sidebar aesthetic
+
+### Star Prompt (Task 4)
+- Dismissible "Star on GitHub" card in About section
+- Shows for new users by default
+- Remembers dismissal in localStorage (`serverkit-star-prompt-dismissed`)
+- Accent-colored gradient design with gold star icon
+- Links to repository
+- Mobile responsive with stacked layout on small screens
+
+## Files Changed
+- `frontend/src/pages/Settings.jsx` - Added Lucide imports, updated AboutSection
+- `frontend/src/components/Sidebar.jsx` - Added GitHub link
+- `frontend/src/styles/pages/_settings.less` - Added update check and star prompt styles
+- `frontend/src/styles/layout/_sidebar.less` - Added sidebar github link styles
+- `frontend/src/services/api.js` - Added checkUpdate() method
+- `backend/app/api/system.py` - Added check-update endpoint with caching
+
+## Commits
+- `78bfb6a` - feat(14): Update About section with correct GitHub links
+- `4f5da49` - feat(14): Add version update check via GitHub releases API
+- `2d32aad` - feat(14): Add GitHub link to sidebar
+- `a20d4ab` - feat(14): Add Star on GitHub prompt for new users
+
+## Verification
+- [x] GitHub link in About section opens correct repository
+- [x] Documentation link opens README
+- [x] Support/Issues link opens GitHub Issues
+- [x] Discussions link opens GitHub Discussions
+- [x] Sidebar GitHub icon visible and functional
+- [x] Update check shows current version status
+- [x] Star prompt displays for new users
+- [x] Star prompt can be dismissed (persisted in localStorage)
+- [x] All icons are Lucide (no inline SVGs in changed code)
+- [x] Build passes without errors
+
+## Notes
+- GitHub API rate limit: 60 requests/hour for unauthenticated requests
+- Update check results cached for 1 hour on backend
+- Star prompt uses localStorage key `serverkit-star-prompt-dismissed`
+- All new icons use Lucide React components for consistency