LitePad 是一个跨平台、简单、纯本地、富文本的笔记软件。
此项目用于学习 ProseMirror 的设计模式、富文本编辑器的实现原理,以及笔记软件的开发实践。
跨平台:使用 NWJS 来实现跨平台。
本地持久化:使用 Dexie 来操作本地 IndexedDB 数据库以存储笔记等数据。
富文本编辑器:基于 ProseMirror 封装实现。
组件库:使用 PrimeVue 作为组件库用以用于提供基础组件。
克隆此项目:
git clone https://github.com/fgt1t5y/LitePad
完成后,进入项目目录:
cd LitePad
⚠️ 注意:此项目强制使用pnpm
管理依赖,如果你还没有安装它,请运行corepack enable pnpm
。
安装项目依赖:
pnpm install
至此,你完成了开发环境的构建。接下来,执行你需要的操作的命令:
pnpm run <命令>
命令列表:
命令 | 说明 |
---|---|
dev | 启动开发服务器和 SDK 模式的 NWJS |
dev:app | 仅启动开发服务器 |
dev:nw | 仅启动 SDK 模式的 NWJS(首次执行需要下载 NWJS 的 SDK) |
build | 构建 App 并打包 NWJS |
build:app | 仅构建 App(首次执行需要下载 NWJS 运行时) |
build:nw | 仅打包 NWJS |
preview | 启动预览服务器(需要先构建 App) |