diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..f6ead8c13c79ad546db01323f5ca70e94ab12e80 --- /dev/null +++ b/README.en.md @@ -0,0 +1,80 @@ +Based on the available information, this project is a full-stack development project comprising both frontend and backend components, as detailed below: + +--- + +## 🧩 Project Overview + +This is a frontend-backend separated architecture development project, primarily featuring the following functional modules: +- **Frontend**: Developed using the Vue.js framework, supporting light/dark mode switching, and includes multiple page components (login, student portal, teacher portal, etc.). +- **Backend**: Developed using Java and Spring Boot, providing basic REST API support. + +--- + +## 📁 Project Structure + +### Frontend (default location: `src/`) +- Developed using the Vue.js framework. +- Includes components, routing, state management, and style resources. +- Configuration files: + - `package.json`: Frontend dependency configuration. + - `vue.config.js`: Vue project build configuration. + - `jsconfig.json`: JavaScript project path configuration. + - `public/`: Static resource files (e.g., JSON configurations, icons, etc.). +- Page layouts: + - Student portal pages (homepage, question details, settings, etc.). + - Teacher portal pages (question management, question bank, settings, etc.). +- Common components: + - `ChatComponent`, `RadarChart`, `CodeHighlight`, etc. + +### Backend (default location: `icode-be/`) +- Developed using the Spring Boot framework. +- Includes a basic entry class: `IcodeApplication.java`. +- Configuration files: + - `pom.xml`: Maven project dependency configuration. + - `application.yaml`: Spring Boot configuration file. +- Test classes: + - `IcodeApplicationTests.java`: Basic startup test class. + +--- + +## 🧰 Development Tools and Dependencies + +### Frontend Dependencies +- Vue 3 +- Vue Router +- Pinia (state management) +- Sass/SCSS styles +- Monaco Editor (code highlighting) +- pnpm (package manager) + +### Backend Dependencies +- Spring Boot +- Maven (build tool) + +--- + +## 🚀 Running the Project + +### Starting the Frontend +Ensure `pnpm` is installed, then run: +```bash +pnpm install +pnpm run dev +``` + +### Starting the Backend +Ensure Maven and JDK are installed, then run: +```bash +cd icode-be +mvn spring-boot:run +``` + +--- + +## 📌 Notes +- Complete configuration files (e.g., `package.json`, `pom.xml`, etc.) are currently unavailable; please verify the project path or supplement the missing configurations. +- The project includes distinct functional modules for student and teacher portals and can be extended according to requirements. + +--- + +For further details about the project, please provide the relevant configuration files or examine the specific code implementation. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3b794f8f25975b74fd17485a451ef5b1f1496c15 --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +根据现有信息,该项目是一个全栈开发项目,包含前端和后端部分,具体如下: + +--- + +## 🧩 项目概述 + +这是一个基于前后端分离架构的开发项目,主要包含以下功能模块: +- **前端部分**:使用 Vue.js 框架开发,支持明暗模式切换,并包含多个页面组件(登录、学生端、教师端等)。 +- **后端部分**:使用 Java 和 Spring Boot 开发,提供基础的 REST API 支持。 + +--- + +## 📁 项目结构 + +### 前端(默认位于 `src/`) +- 使用 Vue.js 框架开发。 +- 包含组件、路由、状态管理和样式资源。 +- 配置文件: + - `package.json`:前端依赖配置。 + - `vue.config.js`:Vue 项目构建配置。 + - `jsconfig.json`:JavaScript 项目路径配置。 + - `public/`:静态资源文件(如 JSON 配置、图标等)。 +- 页面布局: + - 学生端页面(主页、问题详情、设置等)。 + - 教师端页面(问题管理、题库、设置等)。 +- 通用组件: + - `ChatComponent`、`RadarChart`、`CodeHighlight` 等。 + +### 后端(默认位于 `icode-be/`) +- 使用 Spring Boot 框架开发。 +- 包含基础启动类 `IcodeApplication.java`。 +- 配置文件: + - `pom.xml`:Maven 项目依赖配置。 + - `application.yaml`:Spring Boot 配置文件。 +- 测试类: + - `IcodeApplicationTests.java`:基础启动测试类。 + +--- + +## 🧰 开发工具与依赖 + +### 前端依赖 +- Vue 3 +- Vue Router +- Pinia(状态管理) +- Sass/SCSS 样式 +- Monaco Editor(代码高亮) +- pnpm(包管理器) + +### 后端依赖 +- Spring Boot +- Maven(项目构建工具) + +--- + +## 🚀 启动项目 + +### 前端启动 +确保安装了 `pnpm`,然后运行以下命令: +```bash +pnpm install +pnpm run dev +``` + +### 后端启动 +确保安装了 Maven 和 JDK,然后运行以下命令: +```bash +cd icode-be +mvn spring-boot:run +``` + +--- + +## 📌 注意事项 +- 当前未找到完整的配置文件内容(如 `package.json`、`pom.xml` 等),建议检查项目路径或补充配置。 +- 项目包含学生端和教师端的不同功能模块,可根据需求扩展。 + +--- + +如需进一步了解项目细节,请补充相关配置文件内容或查看具体代码实现。 \ No newline at end of file