git-knowledge

• web框架： echo
• 日志框架： zap
• ini配置解析： gopkg.in/ini.v1
• github api客户端：go-github

原型/功能列表

概览：

1. 一个用户可包含多个Space空间
2. 一个空间对应一个Git主配置仓库
3. 配置主仓库中可能组织自己以及其他仓库完成Space空间的内容

配置主要采用yaml形式，示例格式如下：

space:
  # 空间的名称
  name: 我的技术博客
  
# 定义子仓库(数据源)    
repositories:
  - name: notes
    url: 主仓库url
    branch: master
    type: gitbook(使用gitbook的方式解析菜单)
    target: 仓库目标处理文件, 比如 /doc
  - name: Java
    url: 仓库地址
    branch: master
    type: simple_markdown(根据markdown目录的方式解析菜单)
    target: 仓库目标处理文件, 比如 /doc
  - name: Golang
    url: xxx
    branch: master
    type: hexo(根据hexo的方式解析菜单以及标签、访问量、点赞等)
    target: xxx

# 多仓库组织结构配置
group:
  - notes
    - Java
    - Golang

基础功能

• 注册
  • 通过注册页面直接注册
    • 发送账户邮箱验证
    • 邮箱验证
    • 生成随机头像(头像源)
  • 通过Github登录并获取用户信息并直接注册
    • 自动生成userid以及password
    • 将用户信息生成邮件发送给github邮箱
    • 如果用户尚未修改初始密码，则发送消息通知提示用户修改密码
• 登录
  • 通过ID登录
  • 通过Email登录
  • 校验账号邮箱是否激活，如果未激活提示激活，阻止登录，并提示
    • Github注册登录无需校验邮箱
• 首页
• 新建功能菜单
  • 新建空间
• space 空间管理
  • space空间列表
  • 添加已有的space
    • 仓库地址
    • 配置文件位置
  • 创建space
    • 关联指定的github仓库以及相应的分支
    • space的名称、图标
    • 读取仓库信息
      • 待定：是否需要clone仓库
      • 待定：是否要将仓库缓存到数据库中
      • 待定：是否直接调用github API展示内容
• Markdown渲染
  • 图片是否要进行缓存，还是直接调用github
  • SUMMARY.md 文件解析
  • SUMMARY.md 扩展
  • 待定：图片是否要进行缓存，还是直接使用github地址
• 编辑功能
  • 在线修改SUMMARY.md，完成排序、新增、删除、隐藏
  • 如何将修改提交至github
  • 如果出现冲突时该如何解决
• 发布
  • 默认发布形式
    • url: /publish/用户id/空间id/
    • 访问url，调用接口获取空间内容
      • 获取仓库列表
      • 获取仓库下的目录结构
      • 点击某一篇文章，获取文章内容(markdown)

扩展功能

• 支持Gitee
• 读Bilibili视频

架构原型

• conf，配置组件，负责读取ini配置文件为结构体conf.Config
  • 通过conf.InitConfig() 初始化组件
    • 读取配置并创建全局配置结构体对象
    • 提供默认值
    • 提供值的校验
      • 值的类型是否合法
      • 枚举值是否合法
      • 路径是否存在
      • 路径是否有权限
    • 校验不通过会直接退出程序
  • 通过导出方法conf.GetConfig()获取配置文件结构体
• logger，日志组件，负责初始化全局Logger
  • 通过logger.InitLogger() 初始化组件
    • 目的地
    • 日志格式
  • 通过导出的函数提供打印日志的功能，比如：logger.Info()
• helper 帮助
  • util 工具函数

相关资源

• echo 中文
• MongoDB Go Driver使用帮助文档