Skip to content

Commit f824653

Browse files
committed
docs: 添加应用截图和开发指南
- 添加 4 张应用截图展示核心功能 - 更新 README 添加截图展示区域 - 创建 DEVELOPMENT.md 开发指南 - 优化 .gitignore 配置
1 parent d0ae3c6 commit f824653

9 files changed

Lines changed: 283 additions & 3 deletions

File tree

.gitignore

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
1+
# ===================================
2+
# 敏感配置文件 - 包含真实 API keys
3+
# ===================================
4+
js/config.js
5+
js/config.local.js
6+
7+
# ===================================
18
# Node modules
29
node_modules/
310

411
# Build outputs
512
dist/
613
build/
714

8-
# 敏感配置文件 - 包含真实 API keys
9-
js/config.js
10-
15+
# ===================================
1116
# 用户数据和缓存
1217
*.log
1318
*.cache
1419

1520
# 操作系统文件
21+
# ===================================
22+
# macOS
1623
.DS_Store
1724
Thumbs.db
1825

DEVELOPMENT.md

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
# 🔄 后续开发工作流程指南
2+
3+
## 📝 日常开发流程
4+
5+
### 1. 修改代码
6+
7+
在本地正常编辑您的项目文件:
8+
```bash
9+
# 打开项目目录
10+
cd /Users/dk/Codes/train/dev
11+
12+
# 使用您喜欢的编辑器修改代码
13+
# 可以是 VS Code、Sublime Text 等
14+
```
15+
16+
### 2. 本地测试
17+
18+
```bash
19+
# 在浏览器中打开测试
20+
open index.html
21+
open app.html
22+
23+
# 或使用本地服务器
24+
python -m http.server 8000
25+
# 然后访问 http://localhost:8000
26+
```
27+
28+
### 3. 提交到 Git
29+
30+
```bash
31+
# 1. 查看修改了哪些文件
32+
git status
33+
34+
# 2. 添加修改的文件
35+
git add . # 添加所有修改
36+
#
37+
git add 文件名.js # 只添加特定文件
38+
39+
# 3. 提交修改(写清楚改了什么)
40+
git commit -m "feat: 添加新功能XXX"
41+
#
42+
git commit -m "fix: 修复XXX问题"
43+
#
44+
git commit -m "docs: 更新文档"
45+
46+
# 4. 推送到 GitHub
47+
git push
48+
```
49+
50+
### 4. 自动更新到在线演示
51+
52+
推送成功后,GitHub Pages 会自动部署:
53+
- 等待 1-2 分钟
54+
- 访问 https://doubleking-1.github.io/train-flight-records-manager/
55+
- 就能看到最新版本
56+
57+
## 🎯 常见开发场景
58+
59+
### 场景 1:添加新功能
60+
61+
```bash
62+
# 1. 修改代码(例如在 js/app.js 中添加新功能)
63+
# 2. 本地测试确认功能正常
64+
# 3. 提交
65+
git add js/app.js
66+
git commit -m "feat: 添加导出 PDF 功能"
67+
git push
68+
```
69+
70+
### 场景 2:修复 Bug
71+
72+
```bash
73+
# 1. 修改代码修复问题
74+
# 2. 测试确认修复成功
75+
# 3. 提交
76+
git add .
77+
git commit -m "fix: 修复地图加载失败的问题"
78+
git push
79+
```
80+
81+
### 场景 3:更新文档
82+
83+
```bash
84+
# 1. 修改 README.md 或其他文档
85+
# 2. 提交
86+
git add README.md CHANGELOG.md
87+
git commit -m "docs: 更新使用说明"
88+
git push
89+
```
90+
91+
### 场景 4:更新版本
92+
93+
当累积了足够多的更新,可以发布新版本:
94+
95+
```bash
96+
# 1. 更新 CHANGELOG.md,添加新版本说明
97+
# 2. 修改版本号(如 README.md 中的版本)
98+
# 3. 更新 js/app.js 中的导出版本号
99+
# 4. 提交
100+
git add .
101+
git commit -m "chore: 发布 v8.1.0"
102+
git push
103+
104+
# 5. 在 GitHub 上创建 Release
105+
# 访问 https://github.com/Doubleking-1/train-flight-records-manager/releases
106+
# 点击 "Create a new release"
107+
# 填写版本号和更新说明
108+
```
109+
110+
## ⚠️ 重要注意事项
111+
112+
### 1. 保护真实 API Keys
113+
114+
```bash
115+
# ❌ 永远不要提交包含真实密钥的 config.js
116+
git status # 确认 js/config.js 不在待提交列表中
117+
118+
# ✅ 只提交模板文件
119+
git add js/config.example.js # 可以提交
120+
```
121+
122+
### 2. 遇到推送被拒绝
123+
124+
如果出现 `rejected` 错误:
125+
126+
```bash
127+
# 先拉取最新代码
128+
git pull --rebase
129+
130+
# 解决冲突(如果有)
131+
# 然后再推送
132+
git push
133+
```
134+
135+
### 3. 查看提交历史
136+
137+
```bash
138+
# 查看最近的提交
139+
git log --oneline -10
140+
141+
# 查看某个文件的修改历史
142+
git log --oneline -- js/app.js
143+
```
144+
145+
### 4. 撤销修改
146+
147+
```bash
148+
# 撤销工作区的修改(还没 git add)
149+
git restore 文件名
150+
151+
# 撤销已 add 的文件(还没 commit)
152+
git restore --staged 文件名
153+
154+
# 撤销上一次提交(已 commit 但还没 push)
155+
git reset --soft HEAD~1
156+
```
157+
158+
## 📋 提交信息规范(建议)
159+
160+
使用清晰的提交信息:
161+
162+
- `feat: 添加XXX功能` - 新功能
163+
- `fix: 修复XXX问题` - Bug 修复
164+
- `docs: 更新XXX文档` - 文档更新
165+
- `style: 调整XXX样式` - 样式调整
166+
- `refactor: 重构XXX` - 代码重构
167+
- `test: 添加XXX测试` - 添加测试
168+
- `chore: 更新XXX配置` - 构建/配置更新
169+
170+
## 🔄 完整开发循环
171+
172+
```
173+
修改代码 → 本地测试 → git add → git commit → git push → GitHub Pages 自动部署 → 在线查看效果
174+
```
175+
176+
## 💾 备份建议
177+
178+
```bash
179+
# 定期创建完整备份
180+
cp -r /Users/dk/Codes/train/dev ~/Backups/train-dev-$(date +%Y%m%d)
181+
182+
# 或使用 Time Machine / iCloud
183+
```
184+
185+
## 🆘 需要帮助?
186+
187+
如果遇到问题:
188+
1. 查看 Git 状态:`git status`
189+
2. 查看错误信息:仔细阅读 git 的提示
190+
3. 搜索解决方案:复制错误信息到 Google
191+
4. 提 Issue:在 GitHub 上向自己的仓库提 Issue 记录问题
192+
193+
## 🎊 祝开发愉快!

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@
1616
- 导入本地数据文件进行测试
1717
- 完整功能配置请参考下方[快速开始](#快速开始)部分
1818

19+
## 📸 应用截图
20+
21+
### 主页 - 地图概览
22+
![主页截图](screenshots/homepage.png)
23+
24+
### 管理页面 - 数据编辑
25+
![管理页面](screenshots/management.png)
26+
27+
### 统计图表
28+
![统计图表](screenshots/charts.png)
29+
30+
### 地图可视化
31+
![地图可视化](screenshots/map-visualization.png)
1932

2033
## ✨ 主要特性
2134

screenshots/.gitkeep

Whitespace-only changes.

screenshots/README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# 截图指南
2+
3+
## 📸 如何创建应用截图
4+
5+
为了让 README 展示效果最佳,请按以下步骤创建截图:
6+
7+
### 需要的截图
8+
9+
1. **homepage.png** - 主页地图概览
10+
- 打开 `index.html`
11+
- 确保显示了火车和飞机的路线
12+
- 使用 macOS 截图:`Cmd + Shift + 4`
13+
- 保存为 `screenshots/homepage.png`
14+
15+
2. **management.png** - 管理页面
16+
- 打开 `app.html`
17+
- 显示数据表格、统计面板
18+
- 截图保存为 `screenshots/management.png`
19+
20+
3. **charts.png** - 统计图表
21+
-`app.html` 中切换到"统计"标签
22+
- 显示各种图表(年度、铁路局、车型等)
23+
- 截图保存为 `screenshots/charts.png`
24+
25+
4. **map-visualization.png** - 地图可视化
26+
-`app.html` 中显示地图
27+
- 显示路线动画或多条路线
28+
- 截图保存为 `screenshots/map-visualization.png`
29+
30+
### 截图技巧
31+
32+
1. **分辨率**: 建议 1920x1080 或更高
33+
2. **清晰度**: 确保文字清晰可读
34+
3. **内容**: 包含实际数据,不要空白
35+
4. **尺寸**: 压缩后每张不超过 500KB
36+
37+
### 截图后
38+
39+
1. 将截图文件放入 `screenshots/` 目录
40+
2. 提交到 Git:
41+
```bash
42+
git add screenshots/
43+
git commit -m "docs: 添加应用截图"
44+
git push
45+
```
46+
47+
3. 刷新 GitHub 仓库页面,截图会自动显示在 README 中
48+
49+
### 可选:压缩图片
50+
51+
使用工具压缩图片以减小仓库大小:
52+
- macOS: ImageOptim (https://imageoptim.com/)
53+
- 在线工具: TinyPNG (https://tinypng.com/)
54+
55+
### 示例
56+
57+
好的截图应该:
58+
- ✅ 显示应用的核心功能
59+
- ✅ 包含真实的数据示例
60+
- ✅ 界面完整,没有被裁切
61+
- ✅ 配色和主题一致(建议使用暗色模式)
62+
63+
避免:
64+
- ❌ 空白页面
65+
- ❌ 加载中的状态
66+
- ❌ 错误提示
67+
- ❌ 分辨率过低

screenshots/charts.png

335 KB
Loading

screenshots/homepage.png

865 KB
Loading

screenshots/management.png

781 KB
Loading

screenshots/map-visualization.png

658 KB
Loading

0 commit comments

Comments
 (0)