docs: add quick start prompt for future agent sessions

This commit is contained in:
2026-04-01 23:46:36 +03:00
parent 137764fcd3
commit ff2bc8711b
3 changed files with 63 additions and 0 deletions

61
000_START_HERE.md Normal file
View File

@@ -0,0 +1,61 @@
# Quick Start Prompt
Use this prompt to continue the project in a new agent session.
```text
You are continuing work on the repository 3proxyUI.
Start by reading these files in this order:
1. AGENTS.md
2. docs/PLAN.md
3. docs/PROJECT_INDEX.md
4. docs/RESEARCH_3PROXY.md
5. README.md
Project goal:
- Build a Docker-based 3proxy bundle with an admin panel.
- The panel must manage 3proxy users, quotas, services, runtime health, and generated config.
- The UI is already implemented as a stable minimalist frontend prototype and should now be wired to real runtime behavior.
Current state:
- Frontend exists and includes Dashboard, Users, and System tabs.
- Users flow already supports:
- hardcoded panel login
- service-based user assignment
- copy proxy link
- pause/resume UI action
- delete confirmation modal
- Tests and build are green at the current HEAD.
- Official 3proxy documentation has already been reviewed and summarized in docs/RESEARCH_3PROXY.md.
Important constraints:
- Follow AGENTS.md exactly.
- Always update docs/PLAN.md and docs/PROJECT_INDEX.md after meaningful changes.
- Make small, descriptive commits after each completed batch of work.
- Prefer documentation-backed implementation decisions for 3proxy behavior.
- Write edge-case-focused tests, not only happy-path tests.
- Never revert unrelated user changes.
Expected verification commands:
- npm run test:run
- npm run build
- add backend/runtime checks as implementation grows
Primary next implementation target:
1. Replace mock frontend state with a backend control plane.
2. Add a data model for services, users, quotas, and runtime state.
3. Generate valid 3proxy config from backend state.
4. Add runtime actions for start, restart, pause/resume user, and delete user.
5. Add Docker wiring for panel + 3proxy.
If the user asks for additional UI polish or behavior changes, implement them directly, keep the minimalist style, and still update plan/index/commits.
```
## Suggested first commands
```bash
npm install
npm run test:run
npm run build
git status --short
```

View File

@@ -24,3 +24,4 @@ Updated: 2026-04-01
8. Corrected the user-creation flow to select a 3proxy service instead of assigning a per-user port, matching the documented 3proxy model.
9. Stabilized the Users table copy action so the column no longer shifts when the button label changes to `Copied`.
10. Added operator actions in the Users table for pause/resume and delete with confirmation modal coverage.
11. Added a root quick-start prompt file so a new agent can resume implementation or fixes with minimal onboarding.

View File

@@ -4,6 +4,7 @@ Updated: 2026-04-01
## Root
- `000_START_HERE.md`: copy-ready continuation prompt for the next agent session
- `AGENTS.md`: repository workflow rules for autonomous contributors
- `README.md`: quick start and current project scope
- `package.json`: frontend scripts and dependencies