commit 3e69f45d4f3d6bc0cc922101b6bd6f1d9e6c97d9 Author: 12975 <1297598740@qq.com> Date: Wed Jan 28 00:37:00 2026 +0800 first commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..f3df0da --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# OwnK 记账 (OwnK Accounting) + +OwnK 是一款现代化的个人记账应用,旨在提供简洁、高效且美观的财务管理体验。项目基于 React Native 和 TypeScript 开发。 + +## ✨ 主要功能 + +- **多维账本**: 支持资产(现金、银行卡、投资)和负债(信用卡、贷款)账户管理。 +- **交易记录**: 快速记录收入、支出和转账,支持分类、标签和备注。 +- **预算控制**: 灵活设置月度或自定义周期预算,实时监控消费进度。 +- **隐私保护**: 支持隐私模式,一键模糊敏感金额信息。 +- **美观界面**: 采用现代化设计语言,支持深色/浅色模式切换。 + +## 🛠️ 技术栈 + +- **核心框架**: React Native, TypeScript +- **导航**: React Navigation +- **状态管理**: Context API + Hooks +- **网络请求**: Fetch API (封装) +- **样式**: StyleSheet, Vanilla CSS concepts + +## 🚀 快速开始 + +### 环境依赖 + +- Node.js (>= 18) +- Yarn 或 npm +- Android Studio (用于 Android 开发) +- Xcode (用于 iOS 开发,仅限 macOS) +- 后端服务 (需单独部署,默认运行在 `http://localhost:3000`) + +### 安装步骤 + +1. 克隆项目到本地: + + ```bash + git clone + cd app + ``` + +2. 安装依赖: + + ```bash + npm install + # 或者 + yarn install + ``` + +3. (iOS Only) 安装 Pods: + + ```bash + cd ios + pod install + cd .. + ``` + +### 运行应用 + +1. 启动 Metro 服务: + + ```bash + npm start + ``` + +2. 在 Android 上运行: + + ```bash + npm run android + ``` + +3. 在 iOS 上运行: + + ```bash + npm run ios + ``` + +## 📂 目录结构 + +``` +src/ +├── components/ # 可复用组件 (Common, Layouts) +├── contexts/ # 全局状态 Context (Theme, Auth, Privacy) +├── navigation/ # 路由导航配置 +├── screens/ # 页面组件 (Accounts, Transactions, Budget, etc.) +├── services/ # API 服务封装 +├── theme/ # 主题样式定义 +├── types/ # TypeScript 类型定义 +└── utils/ # 工具函数 +``` + +## 🤝 贡献 + +欢迎提交 Issue 或 Pull Request 来改进项目。 + +## 📄 许可证 + +MIT