harveymudd/cs70-student

CS70课程学生开发环境Docker镜像

1. 镜像概述与主要用途

本Docker镜像专为CS70课程学生设计，提供包含课程所需C++编译工具链、依赖库及数据文件的一致开发环境。通过该镜像，学生可在本地（如VS Code）编辑代码，同时利用Docker容器进行编译和运行，解决不同系统环境配置差异问题，确保代码在统一环境中正常工作，简化课程作业的开发流程。

2. 核心功能与特性

• 预置课程依赖：容器内已配置必要的C++编译工具（如clang++）、相关库文件及数据文件，无需学生手动安装依赖。
• 本地文件实时同步：支持通过目录挂载将本地编辑的代码文件映射到容器内，实现本地修改与容器内访问无缝同步。
• 便捷开发流程：可与VS Code等编辑器配合使用，本地编辑代码后直接在容器内编译运行，无需复杂的环境配置步骤。

3. 使用场景与适用范围

主要适用于CS70课程学生完成课程作业时的开发场景：从GitHub Classroom获取作业仓库后，在本地编辑代码，通过本镜像容器编译、运行程序，最终将完成的代码提交至GitHub仓库。

4. 使用方法与配置说明

4.1 获取作业仓库

1. 通过课程提供的GitHub Classroom链接（如https://classroom.github.com/g/22EgwhsN）访问作业仓库创建页面。
2. 根据提示创建团队（个人或小组，小组需确保成员均有权限访问仓库），系统将自动复制课程作业模板仓库，生成个人/团队专属作业仓库（如Homework-01-Just-Lucas）。

4.2 克隆仓库到本地

1. 安装并打开VS Code，在VS Code中打开终端（控制台）。
2. 访问GitHub上生成的个人作业仓库，复制仓库URL。
3. 在终端中执行以下命令克隆仓库到本地：

   bash
   > git clone <github repo url>
   

4. 根据提示输入GitHub账号凭证完成克隆，克隆后可在VS Code中访问和编辑仓库文件。

4.3 Docker环境准备

1. 登录Docker（注：仅镜像开发者需执行，学生在镜像公开后通常无需此步骤）：

   bash
   > docker login
   Username: ...  # 输入Docker账号
   Password: ...  # 输入Docker密码
   

2. 拉取CS70学生镜像：

   bash
   > docker pull docker.xuanyuan.run/lucasbang/cs70-student
   

4.4 运行容器与开发流程

1. 进入本地克隆的作业仓库目录（终端中通过cd <仓库目录名>切换），执行以下命令运行容器，并将当前目录挂载到容器内的/home/student/cs70/路径：

   bash
   > docker run -v $(pwd):/home/student/cs70/ -it lucasbang/cs70-student /bin/zsh
   

   • 参数说明：-v $(pwd):/home/student/cs70/将本地当前目录挂载到容器内指定路径，实现文件同步；-it启用交互式终端；/bin/zsh指定容器启动的shell。

2. 在容器内编译运行代码（以palindrome.cpp为例）：

   bash
   DOCKER > clang++ palindrome.cpp -o palindrome  # 编译代码
   DOCKER > ./palindrome  # 运行可执行文件
   

3. 本地编辑代码：在VS Code中修改本地仓库文件（如palindrome.cpp），由于目录已挂载，容器内可实时访问更新后的文件，无需重新挂载。

4. 退出容器：完成编译运行后，执行以下命令退出容器：

   bash
   DOCKER > exit
   

4.5 代码提交

编辑并测试完成后，通过以下命令将代码提交至GitHub仓库：

bash
> git add palindrome.cpp  # 添加修改的文件
> git commit -m "edited palindrome."  # 提交并添加说明
> git push  # 推送到远程仓库