添加 README.md 文件,提供 Jingji Coder 开发模板的介绍和使用指南

This commit is contained in:
2025-04-30 12:29:59 +08:00
parent 993748db9d
commit 0261a58077

97
README.md Normal file
View File

@@ -0,0 +1,97 @@
# Jingji Coder 开发模板
这是一个基于 [Coder](https://coder.com/) 的 Node.js 开发环境模板,用于快速设置一致的开发环境。
## 简介
该模板使用 Docker 容器创建一个预配置的 Node.js 开发环境,包含常用开发工具和 IDE 支持。通过 Terraform 配置,可以快速部署并管理这些开发环境。
## 环境配置
### 预装软件
- Node.js 20.x
- npm (最新版)
- yarn
- Git
- 基本开发工具 (curl, wget, vim, build-essential)
### 开发工具集成
- VS Code (通过 code-server)
- JetBrains IDEs 支持 (通过 JetBrains Gateway),包括:
- IntelliJ IDEA Ultimate (IU)
- PhpStorm (PS)
- WebStorm (WS)
- PyCharm (PY)
- CLion (CL)
- GoLand (GO)
- RubyMine (RM)
- Rider (RD)
- RustrRover (RR)
## 设置指南
### 前提条件
- 安装 [Docker](https://www.docker.com/get-started)
- 安装 [Terraform](https://www.terraform.io/downloads)
- 安装 [Coder](https://coder.com/docs/coder-oss/latest/install)
### 部署步骤
1. 克隆此仓库到本地
2. 初始化 Terraform 配置
```
terraform init
```
3. 应用 Terraform 配置创建工作空间
```
terraform apply
```
## 使用说明
### 工作空间管理
工作空间创建后,您可以通过以下方式访问:
1. 通过 Web 浏览器访问 VS Code
2. 使用 JetBrains Gateway 连接到您喜欢的 JetBrains IDE
3. 使用 SSH 直接连接到工作空间
### 持久化存储
工作空间使用 Docker 卷 (`coder-{workspace-id}-home`) 来保存您的所有文件和配置,确保在工作空间重启后数据不会丢失。
### 监控资源
工作空间包含以下监控指标:
- CPU 使用率(容器和宿主机)
- 内存使用率(容器和宿主机)
- 磁盘使用情况
- 宿主机负载平均值
- 宿主机交换空间使用情况
## 自定义配置
### 修改 Docker 镜像
如需添加其他工具或依赖,请编辑 `Dockerfile` 并重新构建镜像。
### 修改 Terraform 配置
可以通过编辑 `main.tf` 文件来调整工作空间配置,例如添加更多的环境变量或修改启动脚本。
## 故障排除
如遇问题,请检查:
1. Docker 服务是否正常运行
2. Terraform 配置是否有错误
3. Coder 服务器状态
## 许可证
请参阅项目许可证文件以了解使用条款。