留白项目安装与使用教程

留白项目安装与使用教程

liubai Supercharge yourself! 项目地址: https://gitcode.com/gh_mirrors/li/liubai

1. 项目目录结构及介绍

留白项目是一个集笔记、日程、待办清单和任务管理于一体的AI增强型应用。项目目录结构如下：

.
├─ liubai-backends  # 后端根目录，使用Laf构建
│  └─ liubai-laf   # 存放本项目的云函数
├─ liubai-docs     # 文档根目录，使用VitePress构建
├─ liubai-frontends # 前端根目录
│  └─ liubai-web   # 基于Vue 3.x, Vite, VueUse, TypeScript, Dexie.js, TipTap等构建
│  └─ liubai-vscode-extension # vscode插件根目录，使用typescript编写
└─ memory-bank     # 实验性目录，由AI自主迭代

• liubai-backends: 包含后端代码，使用Laf框架构建，提供项目所需的云函数。
• liubai-docs: 存放项目的文档，使用VitePress构建文档网站。
• liubai-frontends: 包含前端代码，其中liubai-web是基于Vue 3.x等现代前端技术栈构建的前端应用，liubai-vscode-extension是为VSCode开发的插件。
• memory-bank: 实验性目录，完全由AI迭代开发，用于探索AI在项目开发中的应用。

2. 项目的启动文件介绍

项目的启动文件根据不同的模块有所不同：

• 前端启动文件 (liubai-web目录下):

  • pnpm dev: 使用pnpm包管理器启动开发服务器。

• VSCode插件启动文件 (liubai-vscode-extension目录下):

  • pnpm run dev: 使用pnpm启动插件的开发模式。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• 前端配置 (liubai-web目录下):

  • package.json: 定义了项目的依赖、脚本和元数据。
  • pnpm-lock.yaml: 存储了项目的依赖关系和锁定版本，确保在不同环境中的一致性。

• VSCode插件配置 (liubai-vscode-extension目录下):

  • package.json: 同样定义了插件的依赖、脚本和元数据。
  • vscodeignore: 指定VSCode插件项目中应被忽略的文件和目录。

确保在启动项目之前，已经正确安装了所有依赖项，并按照项目要求进行了配置。

liubai Supercharge yourself! 项目地址: https://gitcode.com/gh_mirrors/li/liubai