4.0 KiB
4.0 KiB
Project Index
Updated: 2026-04-02
Root
000_START_HERE.md: copy-ready continuation prompt for the next agent session.dockerignore: trims Docker build context to runtime-relevant files onlyAGENTS.md: repository workflow rules for autonomous contributorscompose.yaml: Docker Compose entrypoint for the bundled panel + 3proxy runtime, including panel auth env defaultsDockerfile: multi-stage image that builds the panel and compiles 3proxyREADME.md: quick start and current project scopepackage.json: frontend/backend scripts and dependencies, including combined localdevstartup and websocket supporttsconfig.server.json: server type-check configurationvite.config.ts: Vite + Vitest configuration plus local/apiand/wsproxying to the control-plane backend
Documentation
docs/PLAN.md: living implementation plandocs/PROJECT_INDEX.md: this indexdocs/RESEARCH_3PROXY.md: notes from official 3proxy documentation
Frontend
src/main.tsx: application bootstrapsrc/App.tsx: authenticated panel shell with API-backed login,sessionStoragetoken persistence, hash-based tab history, websocket snapshot patch sync, localized labels, early theme application, and protected panel mutationssrc/SystemTab.tsx: Settings tab with separate panel-settings and services cards, editable proxy endpoint, dirty-draft protection against incoming live sync, unified service type editing, remove confirmation, and generated config previewsrc/App.test.tsx: login-gate, preferences persistence, hash-tab restoration, websocket-sync safety, modal interaction, pause/resume, delete-confirm, and settings-save UI testssrc/app.css: full panel stylingsrc/data/mockDashboard.ts: default panel state and frontend fallback snapshotsrc/lib/3proxy.ts: formatting and status helperssrc/lib/3proxy.test.ts: paranoia-oriented tests for core domain rulessrc/lib/panelPreferences.ts:localStorage-backed panel language/theme preferences plus theme application helpers withsystemas the default themesrc/lib/panelText.ts: English/Russian UI text catalog for the panel shell and settings flowssrc/shared/contracts.ts: shared panel, service, user, and API data contractssrc/shared/validation.ts: shared validation for user creation, system edits, service type mapping, and quota conversionsrc/test/setup.ts: Testing Library matchers plus browser WebSocket test double
Server
server/index.ts: backend entrypoint, runtime bootstrap, and HTTP server wiring for websocket upgradesserver/app.ts: Express app with login, protected panel state/runtime routes, live-sync change notifications, and writable system configuration API with linked-user cleanup on removed servicesserver/app.test.ts: API tests for user management plus system-update safety, cascade delete, and config edge casesserver/lib/auth.ts: expiring token issuance and bearer-token verification for the panelserver/lib/config.ts: 3proxy config renderer, validation, and dashboard derivation for SOCKS/HTTP managed servicesserver/lib/config.test.ts: config-generation regression testsserver/lib/liveSync.ts: websocket broadcaster that emitssnapshot.initand top-levelsnapshot.patchmessages from runtime/store changesserver/lib/liveSync.test.ts: regression tests for patch-only websocket payload generationserver/lib/snapshot.ts: runtime-backed dashboard snapshot assembly that combines stored panel state with parsed 3proxy traffic observationsserver/lib/traffic.ts: 3proxy access-log reader that derives current user usage, recent activity, daily totals, and lightweight live-connection estimatesserver/lib/traffic.test.ts: parser and empty-runtime regression tests for log-derived traffic metricsserver/lib/runtime.ts: managed 3proxy process controllerserver/lib/store.ts: JSON-backed persistent state store with legacy admin-service migration
Static
public/favicon.svg: Vite default icon placeholder, to replace later