Rhino Editor 项目教程

1. 项目的目录结构及介绍

Rhino Editor 是一个为 Ruby on Rails 应用程序设计的 WYSIWYG 编辑器，它通过集成 TipTap 编辑器与 ActionText 后端兼容。以下是项目的目录结构及其简要说明：

rhino-editor/
├── .changeset/                # Changesets 文件夹
├── .github/                   # GitHub 相关配置
├── .gitignore                 # 定义 Git 忽略的文件
├── .prettierignore            # 定义 Prettier 忽略的文件
├── .ruby-version              # 指定 Ruby 版本
├── .tool-versions             # 定义项目使用的工具版本
├── bin/                       # 存放脚本文件
├── docs/                      # 文档文件夹
├── scripts/                   # 脚本文件夹
├── src/                       # 源代码文件夹
├── tests/                     # 测试文件夹
├── vercel.json                # Vercel 配置文件
├── web-test-runner.config.mjs # Web 测试运行器配置文件
├── CHANGELOG.md               # 更改日志
├── Gemfile                    # Ruby 依赖文件
├── Gemfile.lock               # Ruby 依赖锁定文件
├── LICENSE                    # 许可证文件
├── package.json               # Node.js 依赖及配置文件
├── pnpm-lock.yaml             # PNPM 锁定文件
├── README.md                  # 项目说明文件
├── tsconfig.json              # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于几个关键脚本和配置文件：

• bin/vite: 这个脚本用于启动 Vite 开发服务器。
• bin/rails s: 这是 Rails 的标准启动脚本，用于启动 Rails 服务器。
• docker-compose up --build: 使用 Docker Compose 启动所有服务，包括模拟的 S3 服务器。

启动项目通常需要以下步骤：

1. 在项目根目录下运行 pnpm run setup 来安装依赖。
2. 使用两个终端，一个运行 pnpm run start 来启动 Vite 服务器，另一个运行 cd tests/rails && overmind start -f Procfile.dev 来启动 Rails 服务器及 Overmind。
3. 在浏览器中访问 localhost:5100 查看编辑器。

3. 项目的配置文件介绍

以下是几个重要的配置文件及其作用：

• .ruby-version: 指定项目使用的 Ruby 版本。
• .tool-versions: 定义项目使用的工具版本，如 PNPM 和 Playwright。
• tsconfig.json: TypeScript 配置文件，用于指定 TypeScript 编译器的选项。
• package.json: 包含项目的元数据、脚本和 Node.js 依赖项。
• vercel.json: Vercel 的配置文件，用于自定义项目的部署设置。

正确配置这些文件对于项目能否顺利运行至关重要。