Skip to content

Latest commit

 

History

History
187 lines (140 loc) · 6.38 KB

env.md

File metadata and controls

187 lines (140 loc) · 6.38 KB

OpenCourse 环境配置文档

本文档为 OpenCourse 团队环境配置文档，主要记录开发环境配置相关信息和说明，用于开发时参考使用

如果有任何开发相关问题，请直接联系组长或提交 Issue

1 Backend

1.1 Dependencies

环境配置如下：

  • Java 版本：JDK 21
  • 框架：SpringBoot 3.4.5
  • 构建工具：mvn 3.6.3
  • 数据库：MySQL 8.0+
  • 中间件：Redis 7.2-alpine
  • 文件对象存储系统： MinIO RELEASE.2025-05-24T17-08-30Z

1.2 Environments

本项目提供开发容器进行开发，容器构建脚本为 scripts/setup.sh，如果不使用开发容器请按照 1.1 节中环境信息自行配置

开发容器中已经预装以下配置和工具，并提供了用户免密 sudo 权限，如果你需要其它额外工具可以直接使用 apt-get 进行安装

Fish Shell
Vim
maven
mysql-client
redis-cli
git

开发容器构建流程：

  1. 确保已安装 Docker Desktop，并保持运行
  2. 运行环境变量脚本 bash scripts/env.sh ，创建环境变量目录 .envs/，用于配置容器环境，请根据需要创建所有环境变量
  3. 运行容器构建脚本 bash scripts/setup.sh，等待容器构建完成（注：构建时间可能较久）
  4. 构建完成后，容器会自动后台启动
  5. 连接到容器，进行开发

1.2.1 Environment Variables

一些容器配置信息（如用户名、密码等）作为敏感数据不便于进行公开，因此不纳入版本控制，需要通过本地环境变量配置

在本项目中，每一个 Docker 容器的创建都需要一份环境变量文件，其目录为 .envs/，具体可以参考 .devcontainer/docker-compose.yml 中的信息

本项目必需的环境变量：

# .envs/app.env
# 没有必要的环境变量

# .envs/mysql.env
MYSQL_ROOT_PASSWORD="YOUR ROOT PASSWORD" # 管理员密码
MYSQL_DATABASE="YOUR DATABASE"           # 数据库名称
MYSQL_USER="YOUR USER NAME"              # 用户名
MYSQL_PASSWORD="YOUR PASSWORD"           # 密码

# .envs/redis.env
# 暂时没有用到

# .envs/minio.env
MINIO_ROOT_USER="YOUR ROOT USER"         # 用户名
MINIO_ROOT_PASSWORD="YOUR ROOT PASSWORD" # 密码
MINIO_BROWSER=on
MINIO_DOMAIN=localhost

1.2.2 Devlopment

1.2.2.1 Develop In VsCode

如果你使用 VsCode 进行开发，推荐使用插件 Dev Container（扩展市场搜索 ms-vscode-remote.remote-containers）

  1. 确保容器已运行
  2. 进入 VsCode，点击左下角，选择附加到正在运行的容器，选择 /opencourse，然后进入开发容器
1.2.2.2 Develop In IDEA

如果你使用 IntelliJ IDEA 进行开发，推荐使用功能 Dev Container 进行开发

1.2.2.3 Develop Without Dev-Container

当然，你也可以不使用上述两种方法而直接使用你最方便的方式在 Docker 容器中开发（如在终端运行 docker exec -it opencourse bash 即可进入容器），因为这里的开发容器挂载了你的工作目录，所有的更改都会同步反映到容器中

或者你也可以不使用容器开发，直接自行在本地配置环境

1.3 Build And Run

项目所需依赖已在 pom.xml 中给出，如果有未添加的项目依赖直接在 <dependencies><dependencies/> 中添加

mvn clean              # 清除构建产物
mvn dependency:resolve # 解析并安装依赖
mvn compile            # 编译项目
mvn spring-boot:run    # 运行 SpringBoot 项目
mvn package            # 打包项目
...

1.4 Code Structures

.
├── pom.xml # 项目配置文件
├── target/ # 项目构建产物目录
└── src/    # 源代码目录
    ├── main/
    │   ├── java/
    │   │   └── org/
    │   │       └── opencourse/
    │   │           ├── dto/          # 数据传输对象层：负责接收客户端请求并整合成参数
    │   │           ├── controllers/  # 控制层：负责处理客户端请求并返回响应
    │   │           ├── services/     # 服务层：核心业务逻辑
    │   │           ├── repositories/ # 数据层：处理服务端逻辑对象和持久化数据
    │   │           ├── models/       # 模型层：业务实体定义
    │   │           ├── configs/      # 配置相关
    │   │           ├── utils/        # 其它工具
    │   │           └── Main.java     # 主程序
    │   │ 
    │   └── resources/            # 资源目录
    │       ├── application.yml   # 程序的配置信息，如数据库连接路径
    │       └── schema.sql        # 数据库表定义和初始化脚本
    │
    └── test/                     # 测试目录
        ├── java/                 # 测试代码
        └── resources/            # 测试资源

2 Frontend

2.1 Dependencies

环境配置如下：

  • 包管理器：npm 18.19.1
  • 前端框架：Vue.js + Vite
  • 组件库：Element-Plus

2.2 Environment

直接在开发容器中或你的本地环境中安装即可

2.3 Build And Run

使用以下脚本安装环境：

curl -fsSL https://fnm.vercel.app/install | bash
source /home/opencourse/.config/fish/conf.d/fnm.fish
fnm install 18.19.1
fnm default 18.19.1
fnm use 18.19.1

启动前端：

npm install
npm run dev

2.4 Code Structures

.
├── package.json          # 项目配置文件
├── package-lock.json
├── node_modules/
└── web/                  # 源代码目录
    ├── index.html        # 入口 HTML 文件
    ├── vite.config.js    # Vite 构建工具配置
    ├── public/
    │   └── images/       # 项目图片
    │
    └── src/              # 前端源代码目录
        ├── api/          # API 接口封装
        ├── router/       # 路由配置
        ├── scripts/      # 业务脚本
        ├── stores/       # Pinia 状态管理
        ├── views/        # 页面级 Vue 组件
        ├── utils/        # 工具库
        ├── main.js       # Vue 应用入口文件
        └── App.vue       # Vue 根组件