Skip to content
This repository was archived by the owner on Apr 22, 2026. It is now read-only.

Commit c0109e6

Browse files
committed
docs(readme): 补充目录速览与项目结构说明
1 parent 06f3b3a commit c0109e6

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ CodeX Register 是一个桌面化的 Web 控制台,用于统一管理注册流
1010

1111
- [功能概览](#功能概览)
1212
- [运行架构](#运行架构)
13+
- [目录速览](#目录速览)
1314
- [环境要求](#环境要求)
1415
- [快速开始](#快速开始)
1516
- [界面说明](#界面说明)
@@ -44,6 +45,26 @@ gui.py
4445

4546
目录整理后,核心 Python/前端资源统一放在 `codex_register/`,根目录只保留入口、配置、脚本和文档。
4647

48+
## 目录速览
49+
50+
```text
51+
.
52+
├─ gui.py # 程序入口(窗口/浏览器模式)
53+
├─ codex_register/ # 核心代码包
54+
│ ├─ gui_service.py # 核心编排与状态管理
55+
│ ├─ gui_server_runtime.py # 本地 HTTP API
56+
│ ├─ gui_frontend.py # 前端页面组装
57+
│ ├─ r_with_pwd.py # 注册与 OAuth 主流程
58+
│ ├─ mail_services.py # 邮箱服务工厂
59+
│ └─ mail_providers/ # 各邮箱 Provider 模块
60+
├─ scripts/ # 打包/Release 脚本
61+
├─ .github/workflows/ # CI/CD(Tag 自动发布)
62+
├─ gui_config.example.json # 配置示例
63+
├─ README.md
64+
├─ VERSION
65+
└─ REPOSITORY
66+
```
67+
4768
## 环境要求
4869

4970
- Python `>= 3.10`

0 commit comments

Comments
 (0)