Skip to content

Commit 7e0056e

Browse files
author
qiuwenhao
committed
Merge remote-tracking branch 'origin/main' into release/260315
2 parents 763da01 + 976171f commit 7e0056e

11 files changed

Lines changed: 2800 additions & 786 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -94,46 +94,8 @@ If your device is managed by an organization, you may need your IT admin to allo
9494

9595
## 🛠️ Development
9696

97-
If you want to contribute or build from source, follow these steps:
98-
99-
### Prerequisites
100-
101-
- [Rust](https://www.rust-lang.org/tools/install) (latest stable)
102-
- [Bun](https://bun.sh/) or Node.js (v18+)
103-
104-
### Setup
105-
106-
1. **Clone the repository**
107-
108-
```bash
109-
git clone https://github.com/codeErrorSleep/dbpaw.git
110-
cd dbpaw
111-
```
112-
113-
2. **Install frontend dependencies**
114-
115-
```bash
116-
bun install
117-
```
118-
119-
3. **Run in Development Mode**
120-
121-
**Frontend-only (Mock Mode)** - Recommended for UI work:
122-
123-
```bash
124-
bun dev:mock
125-
```
126-
127-
**Full App (Tauri + Rust)** - For full functionality testing:
128-
129-
```bash
130-
bun tauri dev
131-
```
132-
133-
4. **Build for Production**
134-
```bash
135-
bun tauri build
136-
```
97+
- Development guide: [docs/en/Development/DEVELOPMENT.md](docs/en/Development/DEVELOPMENT.md)
98+
- Contributing guide: [docs/en/Community/CONTRIBUTING.md](docs/en/Community/CONTRIBUTING.md)
13799

138100
## 🏗️ Tech Stack
139101

‎README_CN.md‎

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -94,46 +94,8 @@ _注意：这是因为应用尚未经过 Apple 公证。_
9494

9595
## 🛠️ 开发
9696

97-
如果您想贡献代码或从源码构建，请按照以下步骤操作：
98-
99-
### 前提条件
100-
101-
- [Rust](https://www.rust-lang.org/tools/install) (最新稳定版)
102-
- [Bun](https://bun.sh/) 或 Node.js (v18+)
103-
104-
### 设置
105-
106-
1. **克隆仓库**
107-
108-
```bash
109-
git clone https://github.com/codeErrorSleep/dbpaw.git
110-
cd dbpaw
111-
```
112-
113-
2. **安装前端依赖**
114-
115-
```bash
116-
bun install
117-
```
118-
119-
3. **运行开发模式**
120-
121-
**仅前端（模拟模式）** - 推荐用于 UI 开发：
122-
123-
```bash
124-
bun dev:mock
125-
```
126-
127-
**完整应用（Tauri + Rust）** - 用于完整功能测试：
128-
129-
```bash
130-
bun tauri dev
131-
```
132-
133-
4. **构建生产版本**
134-
```bash
135-
bun tauri build
136-
```
97+
- 开发指南：[docs/zh/Development/DEVELOPMENT.md](docs/zh/Development/DEVELOPMENT.md)
98+
- 贡献指南：[docs/zh/Community/CONTRIBUTING.md](docs/zh/Community/CONTRIBUTING.md)
13799

138100
## 🏗️ 技术栈
139101

‎README_JA.md‎

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -93,46 +93,8 @@ _注: 現時点では Apple の notarization（公証）が未完了のため、
9393

9494
## 🛠️ 開発
9595

96-
コントリビュートやソースからビルドする場合は、以下の手順を実行してください。
97-
98-
### 前提条件
99-
100-
- [Rust](https://www.rust-lang.org/tools/install)（最新 stable）
101-
- [Bun](https://bun.sh/) または Node.js（v18+）
102-
103-
### セットアップ
104-
105-
1. **リポジトリをクローン**
106-
107-
```bash
108-
git clone https://github.com/codeErrorSleep/dbpaw.git
109-
cd dbpaw
110-
```
111-
112-
2. **フロントエンド依存をインストール**
113-
114-
```bash
115-
bun install
116-
```
117-
118-
3. **開発モードで実行**
119-
120-
**フロントエンドのみ（Mock モード）** - UI 作業向け:
121-
122-
```bash
123-
bun dev:mock
124-
```
125-
126-
**フルアプリ（Tauri + Rust）** - 機能全体の確認向け:
127-
128-
```bash
129-
bun tauri dev
130-
```
131-
132-
4. **本番ビルド**
133-
```bash
134-
bun tauri build
135-
```
96+
- 開発ガイド：[docs/ja/Development/DEVELOPMENT.md](docs/ja/Development/DEVELOPMENT.md)
97+
- コントリビューション：[docs/ja/Community/CONTRIBUTING.md](docs/ja/Community/CONTRIBUTING.md)
13698

13799
## 🏗️ 技術スタック
138100

‎docs/en/Community/CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to DbPaw!
4+
5+
## Ways to help
6+
7+
- Report bugs and UX issues via GitHub Issues
8+
- Improve documentation (typos, clarity, screenshots)
9+
- Submit code changes via Pull Requests
10+
11+
## Getting started
12+
13+
For build and dev commands, see [Development Guide](../Development/DEVELOPMENT.md).
14+
15+
## Submitting code changes
16+
17+
1. Fork the repository and create a feature branch
18+
2. Keep changes focused and easy to review
19+
3. Run formatting and tests:
20+
```bash
21+
bun run format
22+
bun run test:all
23+
```
24+
4. Open a Pull Request with:
25+
- what changed and why
26+
- screenshots or screen recordings for UI changes
27+
- steps to verify
28+
29+
## Translations
30+
31+
DbPaw uses i18next and keeps translations in TypeScript:
32+
33+
- Files: `src/lib/i18n/locales/*.ts`
34+
- Existing languages: `en`, `zh`, `ja`
35+
36+
To add a new language, add a new locale file and wire it up in `src/lib/i18n/index.ts` (resources and supported languages).

‎docs/en/Development/DEVELOPMENT.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Development
2+
3+
## Prerequisites
4+
5+
- Rust (latest stable)
6+
- Bun (recommended) or Node.js (v18+)
7+
- Platform toolchain required by Tauri: https://tauri.app/start/prerequisites/
8+
9+
## Setup
10+
11+
```bash
12+
git clone https://github.com/codeErrorSleep/dbpaw.git
13+
cd dbpaw
14+
bun install
15+
```
16+
17+
## Run
18+
19+
Frontend-only (Mock Mode) — recommended for UI work:
20+
21+
```bash
22+
bun dev:mock
23+
```
24+
25+
Full app (Tauri + Rust) — for end-to-end testing:
26+
27+
```bash
28+
bun tauri dev
29+
```
30+
31+
## Build
32+
33+
```bash
34+
bun tauri build
35+
```
36+
37+
## Tests
38+
39+
Run everything:
40+
41+
```bash
42+
bun run test:all
43+
```
44+
45+
Or run a subset:
46+
47+
```bash
48+
bun run test:unit
49+
bun run test:service
50+
bun run test:rust:unit
51+
bun run test:integration
52+
```
53+
54+
## Formatting
55+
56+
```bash
57+
bun run format
58+
```
59+
60+
## Website
61+
62+
The marketing website lives in `website/`.
63+
64+
```bash
65+
bun run website:dev
66+
bun run website:build
67+
```

‎docs/ja/Community/CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# コントリビューションガイド
2+
3+
DbPaw への貢献に興味を持っていただき、ありがとうございます！
4+
5+
## できること
6+
7+
- GitHub Issues での不具合報告 / UX フィードバック
8+
- ドキュメント改善（誤字、説明の追加、スクリーンショット更新）
9+
- PR によるコード貢献
10+
11+
## はじめに
12+
13+
開発・ビルド手順はまずこちら：[開発ガイド](../Development/DEVELOPMENT.md)。
14+
15+
## コード変更の提出
16+
17+
1. リポジトリを Fork してブランチを作成
18+
2. 変更は小さく、レビューしやすく保つ
19+
3. 提出前にフォーマットとテストを実行：
20+
```bash
21+
bun run format
22+
bun run test:all
23+
```
24+
4. PR には以下を含めるのがおすすめ：
25+
- 変更内容と理由
26+
- UI 変更のスクリーンショット / 録画
27+
- 検証手順
28+
29+
## 翻訳
30+
31+
DbPaw は i18next を利用し、翻訳は TypeScript で管理しています：
32+
33+
- パス：`src/lib/i18n/locales/*.ts`
34+
- 既存言語：`en`、`zh`、`ja`
35+
36+
新しい言語を追加する場合は locale ファイルを追加し、`src/lib/i18n/index.ts` で resources と supported languages を更新してください。

‎docs/ja/Development/DEVELOPMENT.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# 開発ガイド
2+
3+
## 前提条件
4+
5+
- Rust（最新の stable）
6+
- Bun（推奨）または Node.js（v18+）
7+
- Tauri に必要なプラットフォームツールチェーン：https://tauri.app/start/prerequisites/
8+
9+
## セットアップ
10+
11+
```bash
12+
git clone https://github.com/codeErrorSleep/dbpaw.git
13+
cd dbpaw
14+
bun install
15+
```
16+
17+
## 起動
18+
19+
フロントエンドのみ（Mock モード）— UI 開発に推奨：
20+
21+
```bash
22+
bun dev:mock
23+
```
24+
25+
フルアプリ（Tauri + Rust）— E2E の動作確認向け：
26+
27+
```bash
28+
bun tauri dev
29+
```
30+
31+
## ビルド
32+
33+
```bash
34+
bun tauri build
35+
```
36+
37+
## テスト
38+
39+
すべて実行：
40+
41+
```bash
42+
bun run test:all
43+
```
44+
45+
個別に実行：
46+
47+
```bash
48+
bun run test:unit
49+
bun run test:service
50+
bun run test:rust:unit
51+
bun run test:integration
52+
```
53+
54+
## フォーマット
55+
56+
```bash
57+
bun run format
58+
```
59+
60+
## Web サイト
61+
62+
マーケティングサイトは `website/` にあります。
63+
64+
```bash
65+
bun run website:dev
66+
bun run website:build
67+
```

‎docs/zh/Community/CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# 贡献指南
2+
3+
感谢你愿意为 DbPaw 贡献力量！
4+
5+
## 你可以做什么
6+
7+
- 通过 GitHub Issues 反馈 Bug / 体验问题
8+
- 改进文档（修正错别字、补充说明、更新截图）
9+
- 提交 PR 贡献代码
10+
11+
## 快速开始
12+
13+
开发与构建命令请先阅读：[开发指南](../Development/DEVELOPMENT.md)。
14+
15+
## 提交代码变更
16+
17+
1. Fork 仓库并新建分支
18+
2. 让改动尽量聚焦，方便 Review
19+
3. 在提交前跑格式化与测试：
20+
```bash
21+
bun run format
22+
bun run test:all
23+
```
24+
4. 提交 PR 时建议包含：
25+
- 改了什么、为什么要改
26+
- UI 改动的截图或录屏
27+
- 验证步骤（如何确认改动有效）
28+
29+
## 参与翻译
30+
31+
DbPaw 使用 i18next，翻译文件以 TypeScript 形式维护：
32+
33+
- 目录：`src/lib/i18n/locales/*.ts`
34+
- 现有语言：`en`、`zh`、`ja`
35+
36+
新增语言时，需要新增 locale 文件，并在 `src/lib/i18n/index.ts` 中补齐 resources 与 supported languages。

0 commit comments

Comments
 (0)