深度笔记应用（DeepNotes）安装与配置指南

深度笔记应用（DeepNotes）安装与配置指南

DeepNotes End-to-end encrypted visual note-taking tool with deep page navigation. 项目地址: https://gitcode.com/gh_mirrors/dee/DeepNotes

1. 项目基础介绍

深度笔记应用（DeepNotes）是一款开源的无限画布工具，它支持端到端加密、深度页面嵌套以及实时协作功能。这款应用适合那些想要在笔记中自由表达，探索复杂概念，并确保笔记安全性的用户。DeepNotes 提供了灵活的笔记系统，可以按需组织笔记，并且支持终身存储，确保用户永远不会丢失任何笔记。

主要编程语言：TypeScript、Vue、JavaScript

2. 项目使用的关键技术和框架

• Vue.js：用于构建用户界面的渐进式JavaScript框架。
• Quasar Framework：一个基于Vue.js的跨平台前端框架，用于构建高性能的应用程序。
• Yjs：一个支持实时协作的数据结构库。
• Tiptap：一个基于Vue的富文本编辑器框架。
• KeyDB 和 Redis：用于可扩展的共享内存和通信的数据库。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装前，请确保您的系统中已安装以下软件：

• Node.js（LTS版本推荐）
• Git
• Docker（如果需要使用 Docker 容器进行部署）

安装步骤

1. 克隆项目仓库

   打开终端（在Windows上可以使用WSL或Git Bash），执行以下命令克隆仓库：

   git clone https://github.com/DeepNotesApp/DeepNotes.git && cd DeepNotes
   

2. 配置环境变量

   将 template.env 文件复制为 .env 并根据需要编辑其中的变量：

   cp template.env .env
   

3. 安装依赖

   使用以下命令安装项目依赖：

   pnpm install
   

4. 构建项目

   构建项目，准备启动：

   pnpm run repo:build
   

5. 启动服务

   使用 Docker Compose 启动后端服务：

   docker-compose up -d
   

6. 启动前端

   根据需要选择启动不同的前端服务器：

   • 单页应用程序（SPA）:

     pnpm run dev:spa
     

   • 服务器端渲染（SSR）:

     pnpm run dev:ssr
     

   • Electron 应用:

     pnpm run dev:electron
     

   • Android 应用（需要Android Studio）:

     pnpm run dev:android
     

   • iOS 应用（需要Xcode）:

     pnpm run dev:ios
     

   如果使用SPA或SSR，请通过 http://localhost:60379 访问应用。

注意：确保在执行以上步骤时，每一步都正确无误。如果在某个步骤中遇到错误，请检查相关日志并解决后再继续。

DeepNotes End-to-end encrypted visual note-taking tool with deep page navigation. 项目地址: https://gitcode.com/gh_mirrors/dee/DeepNotes