1.0.1 • Published 11 months ago

cube-note v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

cube-note

npm.io

一个简单扁平的桌面 / 移动端记事本。基于 react / koa2 / sqlite / typescript / antd。

特性

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

部署

1. docker 安装(推荐)

cube-note 不需要 docker compose,单容器即可运行:

docker run -d -p 3701:3700 -v ~/cube-note-storage:/app hopgoldy/cube-note:1.0.0

执行后数据将会存放在 ~/cube-note-storage 目录。

2. npm 安装

cube-note 在开发时就以简单部署为目标,不需要配置数据库,不需要安装任何软件。仅需 node(16+)环境即可运行。

# 安装项目
# linux 下安装失败时请尝试 sudo 并在安装命令后追加 --unsafe-perm=true --allow-root 参数
npm install -g cube-note

# 启动项目
cube-note run

项目启动后将会在当前目录下生成 config.json,可以通过修改该文件来对应用进行简单的自定义。

服务将默认开启在端口 3700 上,可以通过 cube-note run --port=3701 修改端口。

使用 -h 参数查看更多配置

数据迁移

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

许可

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