首次提交

README.md

@@ -0,0 +1,61 @@
+# 寸进（InchStep）
+
+> 综合成长打卡平台 —— 日日皆有成长，Every inch counts.
+
+## 平台矩阵
+
+| 端 | 技术栈 | 目录 |
+|----|--------|------|
+| Web 端 | Next.js + TypeScript | web/ |
+| 移动端 App | React Native | mobile/ |
+| 微信小程序 | 原生 / Taro | miniapp/ |
+| 管理后台 | React + TypeScript | admin/ |
+| 后端 API | Go + Gin + GORM + MySQL | server/ |
+| 共享代码 | TypeScript 类型/常量 | shared/ |
+
+## 快速开始
+
+### 依赖
+
+- Go 1.22+
+- Docker Desktop（用于 MySQL + Redis）
+
+### 启动步骤
+
+```bash
+# 1. 启动数据库与缓存
+docker-compose -f docker/docker-compose.yml up -d
+
+# 2. 启动后端 API
+cd server
+go run ./cmd/api
+
+# 3. 启动 Web 端（新开终端）
+cd ../web
+pnpm install
+pnpm dev
+
+# 4. 启动移动端（新开终端）
+cd ../mobile
+pnpm install
+pnpm dev
+```
+
+### 构建
+
+```bash
+cd server
+go build -o bin/inchstep-api ./cmd/api
+./bin/inchstep-api
+```
+
+## API 文档
+
+服务启动后访问 `http://localhost:8080/health` 确认状态。
+
+主要 API 前缀：`/api/auth/*`（公开）、`/api/*`（需 JWT 认证）。
+
+## 文档
+
+- [详细需求说明书](docs/寸进_InchStep_详细需求说明书.md)
+- [仓库指南](AGENTS.md)