diff --git a/README.md b/README.md new file mode 100644 index 0000000..7dd387c --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# 刷课平台后端 + +### 功能实现 + +- 登录 +- 获取课程列表 +- 获取网课记录 +- 学习接口 + +### 代码构建 + +**推荐使用 [Taskfile](https://taskfile.dev/) 进行项目构建** + +- 支持命令 + + ``` + * build: 构建前端 + 后端 📦 + * dev: 同时启动前后端(开发模式)🔥 + * rebuild: 清理并重建 🔁 + * release: 构建多平台二进制 🌍 + * upx: 压缩二进制文件 (智能跳过 macOS 和 Windows ARM) + * be:build: 构建后端二进制 🔨 + * be:run: 启动后端服务 🧠 + * dev:be: 只启动后端(配合前端 dev)⚡ + * fe:build: 构建前端 🏗️ + * fe:clean: 清理前端构建产物 🧹 + * fe:dev: 启动前端开发服务器 🚀 + * fe:install: 安装前端依赖 📦 + ``` + +### 项目结构 + +- 目录 + **前端项目地址: [wk-frontend](https://gitea.kmux.cn/zhilv/wk-frontend)** + ``` + . + ├── Taskfile.yml # taskfile 命令定义 + ├── bin # 输出目录 + ├── cmd # 启动入口 + ├── go.mod + ├── go.sum + ├── internal + │   ├── ckwk # 网课接口 + │   ├── conf # 项目配置 + │   ├── dto # 请求响应实体 + │   ├── handler # 控制层 + │   ├── middleware # 中间件 + │   ├── router # 路由定义 + │   └── schedule # 定时任务 + ├── pkg + │   ├── common # 通用工具 + │   ├── log # 日志 + │   └── request # 请求库 + └── web + ├── frontend # 存放前端项目 + └── web.go # 构建时读取前端输出目录 + ```