Twist 技术文档

1. 安装指南

在开始使用Twist之前，请确保您的系统中已安装以下依赖项：

• Ruby 2.2.2
• Rails 4.2.3
• Redis
• PostgreSQL
• Phantom JS（仅用于测试）

安装应用程序及其子模块的依赖项，请运行以下命令：

bundle install
git submodule init
git submodule update

此外，Twist使用Sidekiq来运行一些书籍的背景作业。如果不在后台运行工作者进程，书籍将不会被处理。因此，请确保启动Sidekiq工作者。

2. 项目使用说明

在rails console中创建书籍和用户是最简便的方法：

book = Book.create(title: "Markdown Book Test", path: 'radar/markdown_book_test')
book.enqueue
User.create(email: "[e-mail]", password: "password")

完成以上步骤并确保Sidekiq工作者正在运行后，您应该能够进入应用程序并查看书籍的当前状态。

若要设置post-receive钩子（这是应用程序的核心功能），您需要在GitHub上设置一个钩子，指向http://yourserver.com/books/receive。设置完成后，Twist将自动处理后续操作。

3. 项目API使用文档

Twist项目的API使用目前主要是通过GitHub的post-receive钩子实现自动更新书籍内容。

4. 项目安装方式

如前所述，项目的安装方式涉及以下步骤：

• 确保安装了所有必需的依赖项（Ruby、Rails、Redis、PostgreSQL和Phantom JS）。
• 使用bundle install和git submodule命令安装项目依赖和子模块。
• 在rails console中创建书籍和用户。
• 确保Sidekiq工作者正在运行。
• 设置GitHub的post-receive钩子。

遵循以上步骤，您将能够顺利安装并使用Twist项目。如果在安装或使用过程中遇到任何问题，请参考项目文档或提交issue到项目的GitHub仓库。