【WIP】datawhale 官网项目

一、技术选型

• 编程语言：typescript
• 前端框架：vue3
• 前端组件库：element-plus
• markdown-to-html 解析库：markdown-it
• 前端包管理工具：pnpm
• 流程图绘制库：echart
• 后端框架：express
• orm 框架：typeorm
• 部署工具：pm2

二、目录结构

文件目录	说明
./README.md	说明文档
./deploy	数据库 dump 文件、postman 请求文件
./package	源代码
./package/client	前端源代码
./package/server	后端源代码

三、开发指南

执行bootstrap命令安装 pnpm 和 pm2（如果你没有这两个东西的话） 使用pnpm install命令安装依赖 使用dev:all命令进行开发，访问localhost:8080即可看到网站 使用build:all命令进行打包 使用format命令格式化代码

四、部署指南

执行bootstrap命令安装 pnpm 和 pm2（如果你没有这两个东西的话） 使用start命令启动服务

五、后续 todo

• 1、用户体系搭建
• 2、seo 优化
  • 可以将 csr 渲染改为 ssr 渲染
  • 或将学习内容拆成 ssg 单独部署
• 3、后端接口的补充
  • 现在后端只写了查询接口
  • 需要额外补充创建和更新的接口
• 4、前端性能优化
  • 写的比较快糙猛，
  • 诸如 bundle 懒加载、依赖 tree-shaking 这种常规优化点都可以做一下。
• 5、完善日志和监控
  • 前端埋点使用 shadow-tracker 上报
  • 后端接口丰富日志