62 lines
2.0 KiB
Markdown
62 lines
2.0 KiB
Markdown
# 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
|
|
```
|