48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
# Project Index
|
|
|
|
Updated: 2026-04-01
|
|
|
|
## Root
|
|
|
|
- `000_START_HERE.md`: copy-ready continuation prompt for the next agent session
|
|
- `.dockerignore`: trims Docker build context to runtime-relevant files only
|
|
- `AGENTS.md`: repository workflow rules for autonomous contributors
|
|
- `compose.yaml`: Docker Compose entrypoint for the bundled panel + 3proxy runtime
|
|
- `Dockerfile`: multi-stage image that builds the panel and compiles 3proxy
|
|
- `README.md`: quick start and current project scope
|
|
- `package.json`: frontend scripts and dependencies
|
|
- `tsconfig.server.json`: server type-check configuration
|
|
- `vite.config.ts`: Vite + Vitest configuration
|
|
|
|
## Documentation
|
|
|
|
- `docs/PLAN.md`: living implementation plan
|
|
- `docs/PROJECT_INDEX.md`: this index
|
|
- `docs/RESEARCH_3PROXY.md`: notes from official 3proxy documentation
|
|
|
|
## Frontend
|
|
|
|
- `src/main.tsx`: application bootstrap
|
|
- `src/App.tsx`: authenticated panel shell wired to backend APIs with local fallback behavior
|
|
- `src/App.test.tsx`: login-gate, modal interaction, pause/resume, and delete-confirm tests
|
|
- `src/app.css`: full panel styling
|
|
- `src/data/mockDashboard.ts`: default panel state and frontend fallback snapshot
|
|
- `src/lib/3proxy.ts`: formatting and status helpers
|
|
- `src/lib/3proxy.test.ts`: paranoia-oriented tests for core domain rules
|
|
- `src/shared/contracts.ts`: shared panel, service, user, and API data contracts
|
|
- `src/test/setup.ts`: Testing Library matchers
|
|
|
|
## Server
|
|
|
|
- `server/index.ts`: backend entrypoint and runtime bootstrap
|
|
- `server/app.ts`: Express app with panel state and runtime routes
|
|
- `server/app.test.ts`: API tests for user management edge cases
|
|
- `server/lib/config.ts`: 3proxy config renderer, validation, and dashboard derivation
|
|
- `server/lib/config.test.ts`: config-generation regression tests
|
|
- `server/lib/runtime.ts`: managed 3proxy process controller
|
|
- `server/lib/store.ts`: JSON-backed persistent state store
|
|
|
|
## Static
|
|
|
|
- `public/favicon.svg`: Vite default icon placeholder, to replace later
|