outline 分析
outline
安装
源码
Local development
几个注意点:
- 有两个数据库,redis和postgresql,可以使用docker,也可以直接本地安装
- 默认有host可配置可不配置
- 默认开启https,所以需要SSL,
mkcert
没有使用make up
的本地环境搭建过程
- 下载源代码
git clone git@github.com:outline/outline
- 安装两个数据库,配置账号密码
- 复制
.env.sample
文件成.env
. 添加DATABASE_URL
、REDIS_URL
- 更改
.env.development
的URL是本地的host,或者IP地址 yarn install-local-ssl
安装本地ssl证书yarn install --pure-lockfile
安装依赖yarn dev:watch
启动服务- (可选)配置host
- 打开页面
https://local.outline.dev:3000
登陆 doc
不支持账号密码登录, 只能使用第三方登录,可以使用slack。
源码
前端
技术栈介绍
React、vite、mobx、Styled Components、
入口文件
/outline/app/index.tsx
- HelmetProvider react-helmet-async
- KBarProvider 命令面板是一个浮动窗口,允许用户通过键盘快捷键快速访问和执行各种命令
- framer-motion
- mobx-react
后端
技术栈介绍
nodejs、koa、Sequelize 、bull、