A document of code manager platform

🍳A document of code manager platform.

• Online document editing
• Permission to operate
• Modify record view
• Multi-person writing

• FN: React Mobx Typescript styled-components
• Middleware: Node -> ssr
• BN: Goland
• Cache DB: Redis
• Primary DB: PostgreSQL

Client 文件目录结构:

├── build // dist
├── public // 静态目录存放
├── src
│   ├── app
│   │   ├── ui // 业务无关组件
│   │   ├── assets  // 静态素材
│   │   ├── components // 业务组件
│   │   ├── constant // 常量文件
│   │   ├── index.tsx // bootstrap
│   │   ├── pages // 完整的页面
│   │   ├── routes // 抽象通用的路由
│   │   ├── services // 前端 service
│   │   ├── store // mobx 的 store
│   │   ├── theme // 全局注入的一些样式，包括 styled-components 和 material-design
│   │   └── utils // 工具
│   ├── index.tsx // 启始文件，实际导出真实 index.tsx
│   ├── ssr // 存放 ssr 必须文件
│   └── test // jest 测试

service 可通过封装的 react-ts-di 进行注入

@Injectable()
class Foo {}

------

@Inject
foo!:Foo

store 通过 InjectStore 来进行注入，其实跟 react-ts-di 做了同样的事情，不过维护了两个单例池，考虑是否有必要单独抽出来

export class MainTabs {
 @observable
 tabTag: number = 0;

 @action
 changeTab(): void {
   this.tabTag = 1;
 }
}

------

@InjectStore
tabs!: MainTabs

正则统一封装在 services/regex 下，通过 readonly 常量暴露给外部使用，外部使用正则统一使用注入的 regex, 调用上面的方法

通用的 Validator 经过抽象放在 ui/form-control/validators 目录下，通过 form-control-types 暴露出去

• 文档页面 （3 个 tab）
  • 普通 Markdown 文档页面
  • 规范文档页面 （有 diff）
  • API 文档页面（封装 swagger）
• 组织页面
  • 组织卡片预览页面
  • 组织管理页面，Owner 才能进入
• PUBLIC SPACE
  • 公开文章区
  • 专栏导读
  • 广告区
  • 建议
• Markdown 编辑器
• 新建文档页面
  • 嵌入 markdown
• 消息系统页面
  • 消息列表
  • 消息通知 bar，需要显示条数
  • 具体消息内容
  • 只有删除行为的消息条
  • 有接受和拒绝的消息条

• PUBLIC SPACE 可以发展为类似论坛文章一样的东西，在 UI 上用 Material Design 的 卡片
• 抽离 卡片展示区域 的组件，添加展示方式的功能，列表展示，卡片展示 两种
• 组织点进是该组织下的所有文档，有查看所有组织的所有文档的功能
• 在 PUBLIC SPACE 中设置一些 tab 用来区分小类，建议， 技术文章公开区域，专栏导读, 广告区
• 加入 PUBLIC SPACE，放置一些公开的文档
• 分离出一个没有 header 和没有 footer 的 router-place，放置一些如 登录 注册 之类的页面
• PageHeader 加入图片元素 (效果不是太好，思考一下更好的解决方式)
• markdown 图片交互优化，点击放大
• 写文章页面，富文本编辑器调研
• 组织详情页面
• 组织表结构优化，owner
• 组织概览
• 上传文件缓存，记录 hash key，通过本地对比 hash key 和 文件的链接，判断是否已经上传，返回对应的链接
• 待办事项，许多东西我们不需要及时的处理，因此可加入待办事项
• 添加七牛静态文件托管，抽离上传文件的 service
• 添加 Circle CI 支持
• Docker 自动化部署

-- 优先级低区域

• three.js 应用 - 衍生出一些小游戏彩蛋
• three.js main panel

• 前端组件文档
• swagger API 文档
• markdown 文档

文档是通过组织管理的，一个组织有一个 owner，owner 的权限有

• 增加成员
• 通过成员申请
• 删除成员
• 设置文档权限 （读写，只读，是否公开，是否可见）
• 新建文档
• 删除文档

成员具有的权限

• 邀请成员
• 默认权限（只读）
• 新建文档

新建组织

用户可以在组织内新建文档，新建文档的时候一般有几个选项：

• 文档类型（swagger，组件文档，markdown）

文档写完毕后的选项：

• 该文档的默认权限（默认为只读）
• 是否公开 （默认为否）
  • 如果是⬇️
  • 选择分类 （ref： 分类）

• 随笔
  • 生活
  • 杂文
• 技术
  • 前端
  • 后端
  • 数据库
  • 架构
  • 语言类
  • 框架
  • 轮子
• 广告区 （非不正当言论）

文档由各个分类的类型条件到具体的解析器开始渲染；

文档头部信息包括：

• 属于组织
• 作者信息
  • 头像
  • 名称
• 发表日期
• 版权声明
• 最后一次编辑日期

文档的内容包括：

• 点赞

在此看到的文章都是公开的，都是大家想分享的一些东西