Joplin项目构建与开发环境配置指南

Joplin项目构建与开发环境配置指南

joplin Joplin 是一款安全笔记记录与待办事项应用，具备跨平台同步功能，支持 Windows、macOS、Linux、Android 和 iOS 平台。 项目地址: https://gitcode.com/gh_mirrors/jo/joplin

项目概述

Joplin是一款开源的笔记管理应用，采用现代化的技术架构实现跨平台支持。本文将详细介绍如何搭建Joplin的开发环境，构建各个平台的应用版本，以及开发过程中的注意事项。

项目架构解析

Joplin采用Monorepo（单体仓库）架构管理代码，使用Yarn Workspaces和Lerna工具进行多包管理。主要子包包括：

1. 核心功能包

   • app-cli: 命令行界面应用
   • app-clipper: 网页剪藏扩展
   • app-desktop: 桌面端应用
   • app-mobile: 移动端应用
   • lib: 核心库，处理同步、加密、导入导出等核心业务逻辑
   • renderer: Markdown和HTML渲染器
   • tools: 构建工具集

2. 特殊分支包 项目中还包含一些以"fork-"开头的特殊分支包，这些是对现有包的定制化修改版本。

开发环境准备

依赖安装

项目提供了完整的依赖清单文件，开发者可以通过以下方式安装：

1. 推荐方式（Linux/MacOS）：

   devbox shell
   

   这种方式会自动配置完整的开发环境。

2. 手动安装： 可以参照项目中的配置文件手动安装所有依赖项。

3. 特殊需求： 如果需要开发onenote-converter相关功能，需额外安装Rust工具链。

注意事项

• 项目路径中不应包含空格，否则可能导致构建失败
• Windows用户建议使用标准命令提示符，不推荐使用WSL环境

构建流程详解

初始化步骤

在项目根目录执行：

yarn install

此命令会安装所有必要的依赖项。

各平台应用构建指南

桌面应用开发

cd packages/app-desktop
yarn start

终端应用开发

cd packages/app-cli
yarn start

移动应用开发

Android平台：

cd packages/app-mobile/android
./gradlew installDebug  # Windows使用gradlew.bat installDebug

iOS平台：

1. 需要先执行pod安装：

   cd packages/app-mobile/ios
   pod install
   

2. 使用Xcode打开ios/Joplin.xcworkspace运行项目
3. 确保bundler正常运行（必要时手动启动）

Web开发模式：

cd packages/app-mobile
yarn serve-web  # 开发服务器(8088端口)
yarn serve-web-hot-reload  # 支持热重载
yarn web  # 生产构建

剪藏扩展开发

cd packages/app-clipper/popup
npm run watch

注意：开发模式的扩展只能连接开发版的桌面应用。

开发工作流优化

文件变更监控

项目根目录下运行：

yarn watch

此命令会监控TypeScript文件变更并自动重新编译。

对于移动端WebView内容修改，需要单独运行：

cd packages/app-mobile
yarn watchInjectedJs

启动参数配置

可以为应用添加启动参数：

yarn start -- --debug

技术栈说明

项目正从JavaScript逐步迁移到TypeScript，新代码应使用TypeScript编写。编译后的.js文件会生成在对应的.ts文件旁边，这种设计实现了对现有代码的最小侵入。

常见问题解决

开发过程中可能遇到的问题及解决方案已整理在专门的文档中，建议开发者提前阅读以节省排错时间。

通过本文的指导，开发者应该能够顺利搭建Joplin的开发环境，并开始进行各平台的功能开发与调试工作。

joplin Joplin 是一款安全笔记记录与待办事项应用，具备跨平台同步功能，支持 Windows、macOS、Linux、Android 和 iOS 平台。 项目地址: https://gitcode.com/gh_mirrors/jo/joplin