Fundamental_Analysis/frontend/README.md

86 lines
2.0 KiB
Markdown

# 基本面选股系统 - 前端
这是基本面选股系统的前端应用,使用 Next.js 14 和 TypeScript 构建。
## 技术栈
- **框架**: Next.js 14 (App Router)
- **语言**: TypeScript
- **样式**: Tailwind CSS
- **UI组件**: shadcn/ui
- **字体**: Noto Sans SC (中文支持)
## 项目结构
```
src/
├── app/ # Next.js App Router 页面
│ ├── layout.tsx # 根布局
│ ├── page.tsx # 首页
│ └── globals.css # 全局样式
├── components/ # React 组件
│ └── ui/ # shadcn/ui 基础组件
├── lib/ # 工具库
│ ├── api.ts # API 客户端
│ ├── types.ts # TypeScript 类型定义
│ └── utils.ts # 工具函数
└── hooks/ # 自定义 React Hooks
├── useReport.ts # 报告数据钩子
└── useProgress.ts # 进度追踪钩子
```
## 开发命令
```bash
# 安装依赖
npm install
# 启动开发服务器
npm run dev
# 构建生产版本
npm run build
# 启动生产服务器
npm start
# 代码检查
npm run lint
```
## 功能特性
- ✅ Next.js 14 项目初始化
- ✅ TypeScript 配置
- ✅ Tailwind CSS 样式系统
- ✅ shadcn/ui 组件库集成
- ✅ 中文字体支持 (Noto Sans SC)
- ✅ 基础项目结构
- ✅ API 客户端封装
- ✅ 自定义 Hooks
- ✅ 响应式布局
## 环境变量
创建 `.env.local` 文件并配置以下变量:
```env
NEXT_PUBLIC_API_URL=http://localhost:8000
```
## 开发说明
1. 项目使用 App Router 架构
2. 所有页面组件位于 `src/app/` 目录
3. 可复用组件位于 `src/components/` 目录
4. API 调用通过 `src/lib/api.ts` 统一管理
5. 类型定义集中在 `src/lib/types.ts`
6. 自定义 Hooks 用于状态管理和数据获取
## 下一步开发
- 实现股票搜索表单组件
- 创建报告页面和路由
- 集成 TradingView 图表
- 实现进度显示组件
- 添加配置管理页面