Fulcrum 项目技术文档

1. 安装指南

1.1 系统要求

在安装 Fulcrum 之前，请确保您的系统已经安装了运行 Ruby on Rails 所需的依赖项。您可以通过以下链接查看详细信息：Ruby on Rails 下载页面。

1.2 本地安装步骤

1. 克隆项目：

   git clone git://github.com/fulcrum-agile/fulcrum.git
   cd fulcrum
   

2. 安装依赖：

   gem install bundler
   bundle install
   

3. 设置开发数据库：

   bundle exec rake fulcrum:setup db:setup
   

4. 启动本地服务器：

   rails server
   

5. 访问应用： 在浏览器中访问 http://localhost:3000/，使用测试用户名 [e-mail] 和密码 testpass 登录。

1.3 Heroku 部署步骤

1. 安装 Heroku CLI：

   gem install heroku
   

2. 创建 Heroku 应用：

   heroku create APPNAME --stack cedar-14
   

3. 设置环境变量：

   heroku config:set APP_HOST=APPNAME.herokuapp.com
   heroku config:set MAILER_SENDER=[e-mail]
   heroku config:set BUNDLE_WITHOUT='development:test:travis:mysql:sqlite'
   

4. 添加 SendGrid 插件：

   heroku addons:add sendgrid:starter
   

5. 部署应用：

   git push heroku master
   heroku run rake db:setup
   

6. 访问应用： 在浏览器中访问 http://APPNAME.herokuapp.com。

2. 项目使用说明

2.1 用户故事管理

Fulcrum 是一个基于用户故事的敏捷开发团队 backlog 管理系统。用户故事是描述系统所需行为的方式，通常描述用户与系统的单次交互。例如，一个用户故事可能是“用户可以将产品添加到购物车”或“用户在其他用户评论其主题时收到通知”。

2.2 迭代与速度

Fulcrum 使用“故事点”来评估每个功能的相对难度，而不是估算完成故事所需的时间。团队可以根据自己的需求决定每个故事点的含义，但最重要的是确保每个故事的相对难度。

2.3 实时项目计划

Fulcrum 提供实时项目计划视图，根据团队之前的绩效即时调整项目计划。

3. 项目 API 使用文档

3.1 API 概述

Fulcrum 提供了一套 API，允许开发者与项目进行交互。API 文档可以在项目的 GitHub Wiki 中找到。

3.2 常用 API 示例

• 获取项目列表：

  GET /api/projects
  

• 创建新项目：

  POST /api/projects
  {
    "name": "New Project",
    "description": "This is a new project"
  }
  

• 获取用户故事：

  GET /api/projects/:project_id/stories
  

4. 项目安装方式

4.1 本地安装

如前所述，Fulcrum 可以通过克隆 GitHub 仓库并在本地运行来安装。

4.2 Heroku 部署

Fulcrum 也可以部署到 Heroku，步骤如前所述。

4.3 其他平台部署

Fulcrum 可以部署到任何支持 Rails 的平台。设置过程与普通 Rails 应用相同，但需要根据平台要求进行一些自定义配置。

---

通过以上文档，您应该能够顺利安装、使用和部署 Fulcrum 项目。如有任何问题，请参考项目的 GitHub 仓库或联系开发团队。