Merge pull request #6 from Jinghao-coding/main

add chinese version readme

Author: ganhao2001

README.md

@@ -1,5 +1,7 @@
 #  Storage server
 
+Chinese Version : [README_CN.md](README_CN.md)
+
 Crater is a Kubernetes-based GPU cluster management system providing a comprehensive solution for GPU resource orchestration.
 
 

README_CN.md

@@ -0,0 +1,146 @@
+# Crater存储服务
+
+Crater 是一个基于 Kubernetes 的 GPU 集群管理系统，提供 GPU 资源编排的全面解决方案。
+
+## 💻 开发指南
+
+在开始开发之前，请确保您的环境已安装以下工具：
+
+- **Go**：推荐版本 `v1.25.0`  
+  📖 [Go 安装指南](https://go.dev/doc/install)
+
+- **Kubectl**：推荐版本 `v1.22.1`  
+  📖 [Kubectl 安装指南](https://kubernetes.io/docs/tasks/tools/)
+
+### 📐 代码风格与检查
+
+本项目使用 [`golangci-lint`](https://golangci-lint.run/) 来强制执行 Go 代码约定和最佳实践。为避免手动运行，我们建议设置 Git 预提交钩子，以便在每次提交前自动检查代码。
+
+安装后，您可能需要将 GOPATH 添加到系统 PATH 中，以便在终端中使用 golangci-lint。例如，在 Linux 上：
+
+```bash
+# 检查您的 GOPATH
+go env GOPATH
+# /Users/your-username/go
+
+# 将路径添加到 .bashrc 或 .zshrc
+export PATH="/Users/your-username/go/bin:$PATH"
+
+# 重新加载 shell 并验证
+golangci-lint --version
+# golangci-lint has version 1.64.8
+```
+
+#### 设置 Git 预提交钩子
+
+将 `.githook/pre-commit` 脚本复制到您的 Git 钩子目录并使其可执行：
+
+**Linux/macOS：**
+```bash
+cp .githook/pre-commit .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
+Windows：
+
+* 将脚本复制到 .git/hooks/pre-commit
+* 如果需要，将脚本中的 golangci-lint 替换为 golangci-lint.exe，或将其适配为 .bat 文件。
+
+设置钩子后，golangci-lint 将在每次提交前自动对暂存文件运行。
+
+#### 🛠️ 数据库代码生成
+本项目使用 GORM Gen 来生成数据库 CRUD 操作的样板代码。
+
+生成脚本和文档可在以下位置找到：[ `gorm_gen`](./cmd/gorm-gen/README.md)
+
+修改数据库模型或架构定义后，请重新生成代码，而 CI 流水线将自动进行数据库迁移。
+
+### 项目配置
+安装依赖和插件：
+```bash
+go mod download
+```
+
+## 🚀 运行代码
+
+本项目支持两种运行方式：**本地开发** 和 **部署到 Kubernetes 集群**。我们 **推荐使用 Kubernetes 部署** 以获得完整功能和更接近生产的行为。
+
+---
+
+### 🧑‍💻 本地开发
+
+> 适用于快速测试和开发阶段。
+
+#### 📄 配置：
+
+确保您有一个 [config.yaml](./etc/config.yaml) 文件，其中包含正确的数据库设置。
+
+在根目录创建 `.env` 文件以自定义本地端口。此文件被 Git 忽略：
+
+```env
+PORT=xxxx
+ROOTDIR="/crater"
+```
+
+#### 📁 目录设置：
+
+**在你熟悉的目录下创建一个名为 `crater`（或者其他名字） 的文件夹，以模拟文件处理行为。**
+
+**或者，您可以修改 .env 文件中的 `ROOTDIR` 并将其用作测试的根目录。**
+
+```bash
+mkdir crater
+```
+
+此目录将作为文件处理的根目录。
+
+#### 🚀 运行应用程序：
+
+```bash
+make run
+```
+
+服务将启动并默认监听 `localhost:port`。
+
+---
+
+### ☸️ 部署到 Kubernetes
+
+#### ✅ 先决条件：
+
+- Docker
+- 访问 Kubernetes 集群（`kubectl`）
+- 已创建名为 `crater-rw-storage` 的 PVC（用于持久文件存储）
+
+#### 📦 构建并推送 Docker 镜像：
+
+```bash
+docker build -t your-registry/crater-webdav:latest .
+docker push your-registry/crater-webdav:latest
+```
+
+> 将 `your-registry` 替换为您的实际容器注册表。
+
+#### 🚀 部署到 Kubernetes：
+
+确保当前目录中存在以下文件：
+
+- `Dockerfile`
+- `deployment.yaml`
+- `service.yaml`（如果适用）
+
+您可以在 https://github.com/raids-lab/crater/tree/main/charts/crater/templates/storage-server 找到这些文件
+
+应用清单：
+
+```bash
+kubectl apply -f deployment.yaml
+kubectl apply -f service.yaml
+```
+
+> 确保 `deployment.yaml` 正确引用镜像并挂载 PVC `crater-rw-storage`。
+
+### 🚀 快速部署
+要在生产环境中部署 Crater 项目，我们提供了一个 Helm Chart，可在 [Crater Helm Chart](https://github.com/raids-lab/crater) 获取。
+
+请参考主文档以获取