52 lines
2.3 KiB
Markdown
52 lines
2.3 KiB
Markdown
# A-Share Analysis
|
||
|
||
A read-only A-share market overview and analysis tool.
|
||
|
||
## 当前阶段
|
||
|
||
项目正在建立工程基线，首个业务模块为市场综合概览。当前不包含用户体系、订阅与支付。
|
||
|
||
## Projects
|
||
|
||
- `web/`: Vue 3 market terminal frontend.
|
||
- `server/`: NestJS API、Scheduler 与 Worker 三个独立进程。
|
||
- `deploy/`: MySQL 5.7、Redis、RocketMQ 5.x 的配置契约，以及 systemd/Nginx 源码部署模板。
|
||
- `docs/`: Product and implementation specifications.
|
||
|
||
The first implementation slice is the market overview screen in `web/`.
|
||
|
||
## 环境与部署
|
||
|
||
- [本地开发环境](docs/deployment/local-development.md)：使用开发机已有 Redis，应用全部从源码运行。
|
||
- [Ubuntu 源码生产部署](docs/deployment/ubuntu-source-production.md)：项目唯一生产部署方式，支持 Ubuntu 22.04/24.04 LTS x86_64。
|
||
|
||
无秘密环境模板位于 `deploy/env/`。生产配置不进入 Git 或发布目录；Node.js 22.x、pnpm 10.25.0、Nginx 和外部基础设施由服务器管理员提供。项目不安装、启动、停止或删除 Redis、MySQL 和 RocketMQ。
|
||
|
||
## 开发入口
|
||
|
||
- [文档索引](docs/index.md)
|
||
- [代码开发规范](docs/governance/code-development-standards.md)
|
||
- [开发流程规范](docs/governance/development-workflow.md)
|
||
- [系统架构](docs/architecture/system-architecture.md)
|
||
|
||
开始任何模块前，先阅读根目录 `AGENTS.md`，然后运行：
|
||
|
||
```bash
|
||
npm run schema:baseline
|
||
npm run schema:verify
|
||
npm run governance:start -- FEAT-MO-001 market-overview
|
||
```
|
||
|
||
Schema 命令只允许处理固定开发库；当前 MySQL 未启用时会为上一发布版本生成可验证的不适用清单，不会连接数据库或创建空 SQL。完整规则见 [开发流程规范](docs/governance/development-workflow.md)。
|
||
|
||
## 项目仓库
|
||
|
||
- Gitea：<https://git.foximao.com/FoXiMao/a-share-analysis>
|
||
- 远程名：`origin`
|
||
- 配置范围：仅当前项目的 `.git/config`，不修改 Git 全局配置。
|
||
|
||
凭据不写入仓库、文档或远程 URL。首次需要认证时由 Git 调用 macOS Keychain
|
||
安全保存；详细规则见 [Git 与 Gitea 规范](docs/governance/version-control-and-gitea.md)。
|
||
|
||
验证通过的中文提交必须立即同步当前分支到 Gitea；本次创建的版本标签单独同步。远程同步失败时，开发任务保持未完成状态。
|