ShareServer interactive prototype
This repository contains the first runnable ShareServer project. It is an interactive control-console prototype based on the ShareServer PRD, not a production ShareServer implementation.
Repository and documentation
- Clone:
git clone ssh://git@git.digiman.live:11022/root/goodbuddy-shareserver.git - Feature documentation: requirements, logic, UI, technical design, and verified implementation progress.
- Shared network architecture remains authoritative in the GoodBuddy Desktop repository.
- GoodBuddy UI design system supplies the shared design guidance, not an Electron runtime dependency.
For cross-repository documentation links, clone goodbuddy and
goodbuddy-shareserver next to each other. Building and running ShareServer
does not require the Desktop checkout.
Source and feature documentation were extracted from GoodBuddy commit
ee804edcae828066614e03a3b37e6ba389b09323, from shareserver/ and
docs/features/share-server/. Earlier history remains in that repository.
Included
- Hono HTTP service with health, readiness, prototype snapshot, and prototype action endpoints.
- Same-origin React, Vite, TypeScript, Tailwind CSS, and shadcn/ui-style Web console.
- Administrator views for overview, members, devices, capabilities, policies, approvals, releases, federation, tasks, audit, and settings.
- Member self-service views for personal devices, grants, and requests.
- Responsive navigation, dark and light themes, search, filters, details, forms, confirmations, and keyboard-accessible dialogs.
- Production build and a non-root container image.
The UI uses official shadcn/ui conventions and Radix primitives. Its information
architecture was informed by the MIT-licensed
satnaing/shadcn-admin, but this
project does not copy that template or include its Clerk integration and sample
business pages.
Not included yet
Prototype records are deliberately read-only fixtures. The action endpoint returns an acknowledgement but does not persist changes. PostgreSQL, initialization and login, organization isolation, real authorization, device WebSocket connections, task routing, relay, package storage, federation, and auditable mutations remain production implementation work. The planned Office editing integration also has no current implementation: ONLYOFFICE Docs, object storage, document sessions, save callbacks, checkpoints, and Desktop document tabs remain design work described in the ShareServer feature documentation.
The readiness endpoint reports this explicitly:
{
"status": "ready",
"mode": "interactive-prototype",
"productionReady": false
}
Run locally
cd goodbuddy-shareserver
npm ci
npm run dev
Open http://127.0.0.1:5174. Vite proxies /api to the Hono service on port
8787.
Run the production build
cd goodbuddy-shareserver
npm run build
npm start
Open http://127.0.0.1:8787.
Set SHARESERVER_PORT to use another listen port. Local runs bind to
127.0.0.1 by default; set SHARESERVER_HOST explicitly when a trusted reverse
proxy or container needs another interface. Do not expose the prototype as a
production service.
Container
docker build -t goodbuddy-shareserver-prototype .
docker run --rm -p 8787:8787 goodbuddy-shareserver-prototype
Validation
npm test
npm run typecheck
npm run lint
npm run build