tuchuang.space

测试驱动开发的图床系统. [](https://standardjs.com)

功能

• 提供 RESTful API
• 提供删除上传图片功能

如何贡献

接受 issue, 对于 pr 很谨慎, 如果有疑问请提 issue 或者 mail 至这里

Wiki

Motivation

• 为了锻炼自己架构一个系统的能力
• 锻炼自己的 React 能力
• 锻炼自己的 ant.design 的框架使用能力
• 锻炼自己的 RESTful 的能力
• 锻炼自己的 Node.js 能力
• 锻炼自己 响应式设计 & Coding 的能力

测试规范

1. 测试有时候需要代码提供一些钩子, 一般不会提供给 生产环境/开发环境 使用, 方法以 _ 开头, 比如 post.images.test.js 文件中对于 config.js 文件的测试

/**
 * 设置 oss 客户端
 * **Notes** 该方法只提供给 e2e 测试, 一般不会在程序中调用, 所以该函数以 _ 开头
 * @param {{}} ossClient ali-oss 客户端
 */
_setOssClient (ossClient) {
  this.ossClient = ossClient
}

项目技术选型

前端

• bundler webpack
• 开发环境 webpack-dev-server
• 测试框架 jest
• 底层框架 react
• ui 框架 ant.design
• 路由框架 react-router

bff 层

• 底层框架 Express.js
• 测试框架 jest, supertest
• 进程守护工具 pm2

后端

• 底层框架 Express.js
• 处理文件上传框架 multipart/form-data https://github.com/expressjs/multer
• 开发环境工具 nodemon
• 测试框架 jest, supertest
• 进程守护工具 pm2
• 数据库连接工具 mongoose

数据库

• mongodb

Github Actions Secrets 解读

Github Actions 中的一些 ENV 变量解读

开发环境, CI/CD 解读

本地开发环境

• 图片上传至 localdevelopment.i.tuchuang.space cdn 环境
• 前端静态资源 采用 webpack-dev-server 的本地打包资源

CI

• 代码 push 将执行 browsers.yml, nodejs.yml, dump_actions_context.yml github actions workflow

CD

beta 环境

代码 merge 至 master 分支将执行 deploy_to_beta.yml github actions workflow, 将代码部署至 beta 服务器, https://beta.tuchuang.space, https://www.beta.tuchuang.space 域名下

production 环境

以字母 v 开头的 tag 将执行 deploy_to_prod.yml github actions workflow, 将代码部署至 production 服务器, https://tuchuang.space, https://www.tuchuang.space 域名下

Roadmap

尚未确定, 容易变化

• VSCODE 插件上传图片
• 第三方部署
• 用户登录注册系统, 支持用户的上传文件和查看文件
• 用户级别的 api

沟通