cube-note

cube-note 是基于 nodejs 开发的全栈项目，致力于为个人打造轻量级的 web note 服务。基于 react / fastify / sqlite / typescript 开发。

查看桌面端截图

查看移动端截图

特性

• 🚫 无广告、无收费、完全开源，自己的数据自己掌握
• 🚀 极其简单的部署，仅需两行命令
• 📝 支持 MarkDown 语法，支持实时预览、自动保存
• 🔗 支持笔记内图片、文件上传
• 📱 桌面端 / 移动端全站响应式设计
• 🎯 支持关键字、标签搜索
• 🧩 支持笔记嵌套、管理、收藏、颜色标记

cube-note docker 容器使用

• FRONTEND_BASE_URL 参数用于指定应用部署到的路径，例如想要部署到 https://your-domain/my-sso/，那么该参数就需要配置为 /my-sso/。
• BACKEND_JWT_SECRET 参数用于指定应用的 jwt 密钥，不配置的话，每次重启应用都会生成一个新的密钥。

docker run -d \
  --restart=always \
  -p 9736:3499 \
  -v cube-note-storage:/app/packages/backend/storage \
  -e FRONTEND_BASE_URL=/cube-note/ \
  -e BACKEND_JWT_SECRET=V1StGXR8_Z5jdHi6B-myT \
  hopgoldy/cube-note:0.1.1

初始化安装

1、安装依赖：

pnpm install

2、初始化后端开发数据库：

pnpm init:dev

启动项目

启动后端服务：

pnpm start:backend

启动前端服务：

pnpm start:frontend

然后访问前端服务的地址即可。

本地配置

如果需要自定义本地环境变量配置的话，可以进入对应的项目仓库，例如 packages/frontend 或者 packages/backend，将 .env 文件复制一份 .env.local，并填写其中参数。

.env.local 的配置会覆盖默认的 .env。

本地 docker 构建

镜像构建：

# 在根目录下构建即可
docker build -t cube-note:local .

容器启动：

docker run -p 3001:3499 cube-note:local

数据迁移

所有数据均默认保存在应用目录下的 packages/backend/storage 文件夹里，所以直接将其打包然后复制到其他地方即可。

许可

本项目源码基于 GPL v3 许可开源，点此 查看更多信息。

todo 侧边栏空状态处理