astrbot_plugin_imagestudio/DEVELOPMENT.md

2 KiB

Development Environment

Scope

The repository is currently prepared for v3 S0-1.

Prepared:

  • AstrBot plugin root files and v3 configuration placeholders.
  • v3 top-level module layout: adapters, core, engines, backend, database, assets_builtin, frontend, pages, web, and data.
  • Frontend source skeleton for Plugin Page UI and Standalone Web UI.
  • Runtime data directories with .gitkeep files only.
  • Generated data, local virtual environments, node modules, and build artifacts are ignored.

Not implemented yet:

  • AstrBot adapter registration.
  • Common response DTO and error handling.
  • Request context, permission checks, and audit logger.
  • Database migrations, repositories, and services.
  • P0 API routes.
  • Real UI screens beyond scaffold placeholders.

Local Tools

On this machine, PowerShell blocks npm.ps1; use npm.cmd when needed.

Codex bundled tools are also available:

C:\Users\Administrator\.cache\codex-runtimes\codex-primary-runtime\dependencies\python\python.exe
C:\Users\Administrator\.cache\codex-runtimes\codex-primary-runtime\dependencies\bin\pnpm.cmd

First Tasks

Follow imagestudio_codex_hermes_dev_flow_v3.md and continue with:

S0-2 实现 common response DTO
S0-3 实现 request_id / audit logger 基础工具
S1-1 实现 character_profiles 表、Repository、Service
S1-2 实现 profile_workflows 和 workflow_nodes
S1-3 实现 generation_images

P0 Frozen API Checklist

P0 must implement these before expanding into advanced flows:

ui/bootstrap
dashboard/summary
profiles GET/POST/GET_ONE/PUT
profiles/quick-draft
profiles/{profile_id}/workflows GET/POST
workflows/{workflow_id}
workflows/{workflow_id}/nodes
nodes/{node_id}/generate
nodes/{node_id}/images
images/{image_id}
images/{image_id}/select
jobs
jobs/{task_id}
settings/schema
settings/current
storage/status
media/sign

Do not start a separate FastAPI, Flask, or Vite production port for the plugin. Dev servers may only be used for local frontend development before build output is copied into AstrBot static paths.