Adopt-a-Hydrant 技术文档

1. 安装指南

1.1 环境要求

在安装 Adopt-a-Hydrant 之前，请确保您的系统已安装以下软件：

• PostgreSQL

1.2 克隆项目

首先，克隆项目到本地：

git clone git://github.com/codeforamerica/adopt-a-hydrant.git
cd adopt-a-hydrant

1.3 安装依赖

使用 bundle install 安装项目所需的 Ruby 依赖：

bundle install

1.4 创建数据库

创建数据库并加载数据库模式：

bundle exec rake db:create
bundle exec rake db:schema:load

2. 项目的使用说明

2.1 启动服务器

使用以下命令启动 Rails 服务器：

rails server

启动后，您可以通过浏览器访问 http://localhost:3000 来使用 Adopt-a-Hydrant 应用。

2.2 加载种子数据

如果您需要加载一些初始数据，可以运行以下命令：

bundle exec rake db:seed

3. 项目 API 使用文档

Adopt-a-Hydrant 提供了 RESTful API，允许开发者通过 HTTP 请求与系统进行交互。以下是常用的 API 端点：

3.1 获取所有消防栓信息

• 请求方法: GET
• URL: /api/hydrants
• 响应: 返回所有消防栓的详细信息。

3.2 认领消防栓

• 请求方法: POST
• URL: /api/hydrants/:id/adopt
• 参数: user_id (认领用户的 ID)
• 响应: 返回认领成功的消防栓信息。

3.3 取消认领

• 请求方法: DELETE
• URL: /api/hydrants/:id/adopt
• 参数: user_id (取消认领用户的 ID)
• 响应: 返回取消认领成功的消防栓信息。

4. 项目安装方式

4.1 部署到 Heroku

要将 Adopt-a-Hydrant 部署到 Heroku，请按照以下步骤操作：

1. 生成新的密钥：

   rake secret
   

2. 在 Heroku 上设置密钥：

   heroku config:set SECRET_TOKEN=the_token_you_generated
   

3. 预编译资源：

   RAILS_ENV=production bundle exec rake assets:precompile
   git add public/assets
   git commit -m "vendor compiled assets"
   

4. 添加生产数据库配置： 在 config/database.yml 中添加生产环境的数据库配置。

5. 加载种子数据：

   heroku run bundle exec rake db:seed
   

4.2 Google Analytics 集成

如果您希望使用 Google Analytics 跟踪应用的访问情况，可以通过以下命令设置环境变量：

heroku config:set GOOGLE_ANALYTICS_ID=your_id
heroku config:set GOOGLE_ANALYTICS_DOMAIN=your_domain_name

例如，your_id 可以是 UA-12345678-9，your_domain_name 可以是 adoptahydrant.org。

结语

通过本文档，您应该能够成功安装、使用并部署 Adopt-a-Hydrant 项目。如果您在过程中遇到任何问题，请参考项目的 GitHub 页面或提交问题报告。