Rhino Editor 安装与配置指南

1. 项目基础介绍

Rhino Editor 是一个用于 Ruby on Rails 的 WYSIWYG 编辑器集成包，它允许用户通过 TipTap 编辑器与 ActionText 后端进行交互。该项目旨在提供一种即插即用的富文本编辑体验，并计划支持 ProseMirror 编辑器以实现 Markdown 和 WYSIWYG 编辑。

主要编程语言包括 TypeScript、Ruby、JavaScript、CSS 和 HTML。

2. 关键技术和框架

• TipTap: 一个基于 ProseMirror 的富文本编辑器框架。
• ProseMirror: 一个用于构建富文本编辑器的框架。
• ActionText: Rails 6 引入的富文本编辑功能。
• PNPM: 一个替代 npm 的包管理工具。
• Playwright: 一个 Node.js 库，用于自动化 Chromium、Firefox 和 WebKit 浏览器。
• Docker: 用于运行模拟 S3 服务器等环境。

3. 安装和配置准备工作

在开始安装之前，请确保您的开发环境中已安装以下依赖项：

• Ruby 3.1.2
• Rails 7.0.4
• PNPM (通过命令 npm install -g pnpm 安装)
• Playwright (通过命令 npm install -g playwright 安装)
• Node.js 版本 16 或以上
• Docker (用于运行模拟 S3 服务器)
• Docker Desktop 或其他 Docker 虚拟化工具
• Overmind (推荐，但不是必需，通过命令 npm install -g overmind 安装)

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/konnorrogers/rhino-editor.git
   cd rhino-editor
   

2. 安装项目依赖：

   pnpm run setup
   

3. 运行服务器：

   使用 Overmind：

   • 启动 Docker 虚拟化工具。
   • 打开两个终端：
     • 终端 1: 运行 pnpm run start。
     • 终端 2: 切换到 tests/rails 目录，运行 overmind start -f Procfile.dev。
   • 在浏览器中访问 localhost:5100。

   不使用 Overmind：

   • 在一个终端中运行 bin/vite dev --clobber。
   • 在另一个终端中运行 bin/rails s。
   • 运行 docker compose up --build。
   • 在浏览器中访问 localhost:5100。

4. 运行测试套件：

   确保 Docker 服务器正在运行，否则测试套件将无法通过。 运行 docker compose up --build，然后执行 bundle exec rails test:all。

5. 监听包变化：

   保持 Rails 服务器运行，打开新的终端并运行 pnpm run start。这将启动一个 ESBuild 观察者进程。Rails 中的 Vite 将自动拾取变化。

6. 添加更改日志条目：

   使用 changesets 工具，运行 pnpm changeset 命令并按照提示操作。

以上就是 Rhino Editor 的详细安装和配置指南。按照以上步骤操作，您应该能够顺利地安装并运行该项目。