Home

欢迎成为高校协同开发的一员，在这里你能够和一群志同道合，积极向上的同学一起学习，完成项目开发，从中快速掌握职业技能点，拓宽知识能力视野，提升个人综合竞争力

一、快速开始

1. 从主仓库fork代码到自己的个人仓库

项目主仓库将开源项目代码 fork 到个人仓库，完成后就可以在个人项目下查看该开源项目代码了

2. git clone 自己仓库的代码到本地

1. 在自己电脑新建一个空目录（PS：本地开发路径中请不要包含中文）
2. cd 进入新建的空目录,进行git clone

# 克隆自己git仓库代码到本地
git clone https://github.com/wheel-w/bk-training-open.git
# 添加自己fork的主仓库源
git remote add blueking-train https://github.com/TencentBlueKing/bk-training-open.git
git pull blueking-train

3. 本地运行项目

1. 在C:\Windows\System32\drivers\etc下的host文件中添加

   127.0.0.1 dev.paas-edu.bktencent.com
   

2. 本地创建数据库

   CREATE DATABASE `bk-training-open` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
   

3. 将config/dev.py复制到项目根目录下，并且重命名为local_settings.py，然后在local_settings.py添加数据库配置

   DATABASES = {
       "default": {
           "ENGINE": "django.db.backends.mysql",
           "NAME": APP_CODE,  # noqa
           "USER": "", # 自己的mysql用户名
           "PASSWORD": "",# 自己的mysql密码
           "HOST": "localhost",
           "PORT": "3306",
       },
   }
   

   PS：local_settings.py是自己的本地开发环境配置，不需要提交到git上

4. 运行

   pip install -r requirements.txt
   python manage.py migrate
   python manage.py runserver dev.paas-edu.bktencent.com:8000

5. 浏览器打开http://dev.paas-edu.bktencent.com:8000 测试get请求和post请求是否发送成功

6. 本地运行bkui，检测跨域配置

   # 进入前端工作目录
   cd frontend
   # 下载依赖
   npm i
   # 运行项目
   npm run dev
   

   浏览器访问index (bktencent.com) 点击发送get,post请求

   

二、开发须知

1. 开发模式----基于PR的开发模式

1. 开发前，首先git pull 项目主仓库下拉最新代码

   git pull blueking-train
   

2. 然后基于自己要开发的分支新建分支进行开发

3. 开发完成后,提交代码到自己的个人仓库

   git add .
   git commit -m 提交信息
   git push origin
   

4. 打开自己的github,提PR(Pull requests)

5. 提交pr之后，主仓库负责人进行提交代码的review，通过则合入开发分支

6. 没有通过，开发者则根据review的修改意见修改完善代码

2. 开发规范

• 前端规范------文档中心 | 蓝鲸 (tencent.com)

• 后端规范------文档中心 | 蓝鲸 (tencent.com)

• 代码提交规范

  • 在根目录新建.gitignore，忽略掉不需要提交的文件

    .gitignore
    __pycache__
    .idea
    node_modules
    local_settings.py
    

  • 配置pre-commit

    pre-commit在git add提交之后，然后执行git commit时执行，如果脚步执行没有报错就继续提交，否则就驳回提交的操作，从而实现对代码的检查、优化代码格式等任务。

    # 安装pre-commit
    pip install pre-commit
    
    # 安装git hook脚本,成功之后会在.git/hooks里生成pre-commit文件
    pre-commit install
    
    # 运行所配置的所有规则，使其起作用
    pre-commit run --all-files
    
    

  • commit分类-----每次代码提交必须有备注说明，注明本次提交做了哪些修改

    bugfix - 线上功能 bug

    sprintfix - 未上线代码修改 （功能模块未上线部分 bug）

    minor - 不重要的修改（换行，拼写错误等）

    feature - 新功能说明

    # 新增功能提交代码则
    git add .
    git commit -m feature:xxxx
    
    # 修复线上功能的bug则
    git add .
    git commit -m bugfix:xxxxxxxxxxxxx
    

三、日报系统

1. 每日小结

1. 根据用户所在组获取日报模板，如果没有日报模板，则使用提供的两个默认日报模板（模板1：今日总结 明日计划 感想 ；模板2： 今日总结 明日计划）
2. 用户点击保存日报进行日报保存 <1> 如果日期为当前日期，点击保存日报，日报保存到数据库，日报状态变为已保存 <2> 如果日期为之前的日期，点击保存日报，用户可选择仅保存或者保存并且发送邮件通知

2. 我的组

1. 新建组,点击弹窗
2. 编辑基本信息，修改组的管理员和名称
3. 创建日报模板，使用输入框，多个内容以“,”分隔, 例如创建模板---今日总结 明日计划 感想 ，则在输入框输入(今日总结,明日计划,感想）
4. 添加成员

3. 每日小结查看

1. 显示用户所在的组，点击对应组展开对应的成员列表
2. 点击组旁边的日期按钮，切换到日报维度为日期，点击对应日期，显示某一天组内所有成员的工作总结

4. 定时任务

1. 邮件模板编写
2. 每天早上10点向组内成员发邮件推送前一天的工作总结和今日计划
3. 每天晚上8点邮件提醒用户进行今天的总结

四、学习资料

1. 在线课程【蓝鲸开课】2020秋季蓝鲸基础开发实战课程-学习视频教程-腾讯课堂 (qq.com)

2. 文档中心文档中心 | 蓝鲸 (tencent.com)

3. django-rest-frameworkHome - Django REST framework (django-rest-framework.org)

4. django 2.2Django 文档 | Django 文档 | Django (djangoproject.com)

5. 前端组件库蓝鲸 MagicBox-Vue 组件库 (tencent.com)

6. vue语法介绍 — Vue.js (vuejs.org)

五、其他文档

1. 日报系统使用指南

1. 获取开发者账号

本日报系统需要使用蓝鲸开发者账号登陆，获取步骤如下

1. 扫描下方二维码加入联合开发项目群
2. 查看群公告填写申请账号问卷调查
3. 等待账号开通成为蓝鲸开发者

入群暗号：高校项目

2. 日报平台地址：蓝鲸日报平台

3. 创建小组

初次登录系统时，管理员需要创建小组，普通用户可以直接查看申请加入其他人创建的组

创建人默认为小组管理员。其他管理员可以在创建小组的时候添加员，也可以在之后编辑小组处添加

4. 管理员主动添加成员

5. 申请加入其他人创建的组（需要管理员同意）

申请加入小组：

管理员审批入组请求：

6. 日报查看

在日报查看页面可以查看所有人的日报，可以按照日期或者成员查看

7. 写日报

写日报是本系统中重要的功能

8. 请假

点击填写日报页面的请假管理可以打开请假面板

在请假面板中可以：

1. 查看所有人的请假信息

2. 删除 / 修改自己未来的请假信息（过期的请假不可修改）

   

9. 时间安排

我们设计时间安排页面的目的是方便管理员了解各个成员可以投入到开发的时间，方便分配任务，以免一周十门课还被安排了非常重的任务。

2. 日报平台新旧界面对比

1. 日报填写

旧版：

新版：

2. 日报查看

旧版：

新版：

3. 我的小组

旧版：

新版：