whereuat 项目技术文档

1. 安装指南

在您的 Rails 应用的 Gemfile 中添加 whereuat：

gem 'whereuat'

完成添加后，运行 bundle install 来安装该宝石。

2. 项目使用说明

whereuat 为您的 Rails 应用添加了一个侧边栏，用于引导用户测试在 Pivotal Tracker 中标记为 'delivered' 的测试故事。

初始化配置

创建一个初始化文件，将 Whereuat::RackApp 添加到 middleware 栈中，并配置您的 Pivotal Tracker API 令牌和项目 ID：

require 'whereuat'

Whereuat.configure do |config|
  config.pivotal_tracker_token   = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  config.pivotal_tracker_project = 123456
end

在应用布局中使用 Helper

在您的应用布局中（建议在 body 的最后），使用以下 Helper 方法：

= whereuat

这个 Helper 将会插入一小段 JavaScript 代码，在每个页面的左侧添加一个小标签。

请注意，whereuat 需要在您的布局或模板中包含 jQuery。

重新加载您的应用页面，然后尝试使用它。

3. 项目 API 使用文档

whereuat 的配置通过 Whereuat.configure 方法完成。以下是可配置的选项：

• pivotal_tracker_token: Pivotal Tracker 的 API 令牌。
• pivotal_tracker_project: Pivotal Tracker 项目的 ID。

4. 项目安装方式

除了通过 Gemfile 安装外，您还可以通过以下方式安装 whereuat：

• 手动下载或克隆仓库到本地。
• 将 whereuat 目录移动到您的 Rails 应用的 vendor/gems 目录下。
• 在 Gemfile 中指定路径，例如：

gem 'whereuat', path: 'vendor/gems/whereuat'

然后执行 bundle install。

确保在完成安装后，根据上面的初始化配置进行配置，并在布局中使用 Helper 方法。