docs: 更新 README 文档并优化项目结构
- 更新 README 文档,增加项目简介、功能特性、技术栈等内容 - 优化 .gitignore 文件,添加更多需要忽略的文件和目录 - 调整项目结构,为开发环境搭建提供更详细的说明
This commit is contained in:
parent
b3c1592eef
commit
103cf81bf6
78
.gitignore
vendored
78
.gitignore
vendored
@ -1,7 +1,73 @@
|
||||
/.nyc_output
|
||||
/coverage
|
||||
/node_modules
|
||||
/sign
|
||||
/dist
|
||||
/build
|
||||
# Dependencies
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
package-lock.json
|
||||
|
||||
# Build outputs
|
||||
/build/
|
||||
/dist/
|
||||
*.rpk
|
||||
|
||||
# Signing certificates and private keys
|
||||
/sign/
|
||||
*.pem
|
||||
*.p12
|
||||
*.keystore
|
||||
|
||||
# Coverage reports
|
||||
/.nyc_output/
|
||||
/coverage/
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
logs/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
lerna-debug.log*
|
||||
|
||||
# Runtime data
|
||||
pids/
|
||||
*.pid
|
||||
*.seed
|
||||
*.pid.lock
|
||||
|
||||
# IDE and Editor files
|
||||
.vscode/
|
||||
.idea/
|
||||
*.iml
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# OS generated files
|
||||
.DS_Store
|
||||
.DS_Store?
|
||||
._*
|
||||
.Spotlight-V100
|
||||
.Trashes
|
||||
ehthumbs.db
|
||||
Thumbs.db
|
||||
|
||||
# Temporary files
|
||||
*.tmp
|
||||
*.temp
|
||||
.cache/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
# Test fixtures
|
||||
/tests/fixtures/
|
||||
|
||||
# Husky
|
||||
.husky/
|
||||
|
||||
# Claude Code settings (keeping local config only)
|
||||
.claude/settings.local.json
|
||||
46
README.md
46
README.md
@ -1,25 +1,27 @@
|
||||
# TOTP验证器 - 小米手环10版
|
||||
|
||||
一个专为小米手环10设计的TOTP(时间一次性密码)验证器应用,支持生成双因素认证码。
|
||||
一个基于小米Vela JS应用框架开发的TOTP(时间一次性密码)验证器,专为小米手环10设计,为用户提供便捷的双因素认证体验。
|
||||
|
||||
## 🎯 项目简介
|
||||
|
||||
本项目是一个运行在小米手环10上的验证器应用,支持生成TOTP和Steam验证码。通过简洁的界面和触感反馈,为用户提供便捷的二步验证体验。
|
||||
本项目是一个运行在小米手环10上的验证器应用,基于小米Vela JS平台开发。支持生成TOTP和Steam验证码,通过简洁的界面和触感反馈,为用户在手环设备上提供便捷的二步验证体验。
|
||||
|
||||
## ✨ 功能特性
|
||||
|
||||
- 🔐 **多种验证码支持**:支持标准TOTP和Steam验证码算法
|
||||
- ⏰ **实时倒计时**:弧形进度条显示验证码剩余有效时间
|
||||
- 📱 **响应式界面**:针对手环屏幕尺寸优化的用户界面
|
||||
- 📱 **响应式界面**:针对小米手环10屏幕尺寸优化的用户界面
|
||||
- 📳 **触感反馈**:验证码更新、页面切换时的震动提醒
|
||||
- 🔄 **自动刷新**:验证码自动更新,无需手动操作
|
||||
- 📊 **详情查看**:大字体显示验证码,方便查看
|
||||
- ⚡ **性能优化**:针对手环设备的电量和性能优化
|
||||
- ⚡ **性能优化**:针对小米手环10的电量和性能优化
|
||||
|
||||
## 🛠️ 技术栈
|
||||
|
||||
- **开发框架**:快应用 (QuickApp)
|
||||
- **开发框架**:小米Vela JS应用框架
|
||||
- **开发工具**:AIoT-IDE(基于VS Code)
|
||||
- **UI技术**:UX模板语言
|
||||
- **运行时**:JavaScript Runtime
|
||||
- **加密算法**:HMAC-SHA1, Base32编码
|
||||
- **依赖库**:crypto-js
|
||||
- **构建工具**:aiot-toolkit
|
||||
@ -44,34 +46,52 @@ src/
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Node.js >= 8.10
|
||||
- aiot-toolkit >= 2.0.4
|
||||
- 小米手环10设备
|
||||
- **开发工具**:AIoT-IDE(推荐)或 VS Code + Vela插件
|
||||
- **Node.js**:>= 8.10
|
||||
- **构建工具**:aiot-toolkit >= 2.0.4
|
||||
- **目标设备**:小米手环10
|
||||
|
||||
### 开发环境搭建
|
||||
|
||||
1. **克隆项目**
|
||||
1. **安装AIoT-IDE**
|
||||
- 下载AIoT-IDE开发工具
|
||||
- 或使用VS Code并安装Vela相关插件
|
||||
|
||||
2. **克隆项目**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd totp-authenticator
|
||||
```
|
||||
|
||||
2. **安装依赖**
|
||||
3. **安装依赖**
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
3. **开发调试**
|
||||
4. **开发调试**
|
||||
```bash
|
||||
# 启动开发服务器(支持热重载)
|
||||
npm start
|
||||
|
||||
# 或使用AIoT-IDE的调试功能
|
||||
# 连接设备进行真机调试
|
||||
```
|
||||
|
||||
4. **构建发布**
|
||||
5. **构建发布**
|
||||
```bash
|
||||
# 构建项目
|
||||
npm run build
|
||||
|
||||
# 生成发布包
|
||||
npm run release
|
||||
```
|
||||
|
||||
### 设备调试
|
||||
|
||||
1. **模拟器调试**:使用AIoT-IDE内置模拟器
|
||||
2. **真机调试**:通过USB或Wi-Fi连接小米手环10设备
|
||||
3. **日志查看**:在开发工具中查看设备运行日志
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 账户配置
|
||||
@ -161,7 +181,7 @@ prettier --write "src/**/*.{ux,js}"
|
||||
|
||||
- 使用 `console.log` 进行调试
|
||||
- 通过 `aiot start --watch` 实现热重载
|
||||
- 检查手环设备日志排查问题
|
||||
- 检查小米手环10设备日志排查问题
|
||||
|
||||
## 📋 待办事项
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user