auto-openai-account AGENTS.md

AGENTS.md

Project Summary

auto-openai-account is a Go backend with an embedded React UI for local account automation workflows.

Production should run as one Go service that serves:

• /api/* JSON API and SSE events
• / React app
• /assets/* React static assets

The backend stays in Go. The frontend stays in React, TypeScript, Vite, and Tailwind CSS. SQLite is the first storage backend.

Read First

Before making non-trivial changes, read these files:

• docs/requirements.md for product scope and first-version requirements
• docs/architecture.md for module layout and boundaries
• docs/design.md for UI and interaction direction
• docs/api.md for current API contracts

Project Layout

• apps/server/main.go: Go server entrypoint
• apps/web: React + Vite frontend
• internal/api: HTTP routing, request parsing, response formatting, SSE endpoint handlers
• internal/domain: shared business types, JSON fields, status constants, default settings
• internal/storage: SQLite schema, migrations, persistence queries, data mapping
• internal/runner: job creation, concurrency, cancellation, runtime logs, SSE fanout
• internal/legacy: account automation implementation kept behind current app boundaries
• internal/proxypool: proxy connectivity tests
• internal/webui: embedded frontend filesystem and static UI handler
• docs: product, architecture, API, and design notes

Development Commands

Backend:

go test ./...
go run ./apps/server

Frontend:

cd apps/web
npm run dev
npm run build

The default server listen address is :8080. It can be overridden with AUTO_OPENAI_ACCOUNT_LISTEN.

Verification Rules

Run the smallest useful verification for the files changed.

• Backend changes: go test ./...
• Frontend changes: cd apps/web && npm run build
• API contract changes: update docs/api.md and verify frontend types in apps/web/src/types.ts
• UI behavior changes: verify the affected page builds and follows docs/design.md