Whitehall 项目技术文档

1. 安装指南

Whitehall 是一个基于 Ruby on Rails 的应用程序，用于创建和管理内容。为了确保顺利运行 Whitehall，建议使用 GOV.UK Docker 环境来管理依赖和运行命令。

1.1 安装 GOV.UK Docker

首先，您需要安装 GOV.UK Docker 环境。请按照以下步骤操作：

1. 克隆 GOV.UK Docker 仓库到本地：

   git clone https://github.com/alphagov/govuk-docker.git
   

2. 进入克隆的目录：

   cd govuk-docker
   

3. 启动 Docker 容器：

   docker-compose up
   

1.2 安装 Whitehall

在 GOV.UK Docker 环境启动后，您可以通过以下步骤安装 Whitehall：

1. 克隆 Whitehall 仓库到本地：

   git clone https://github.com/alphagov/whitehall.git
   

2. 进入 Whitehall 目录：

   cd whitehall
   

3. 安装依赖：

   bundle install
   

2. 项目的使用说明

Whitehall 主要用于创建和管理内容。以下是基本的使用步骤：

2.1 启动应用程序

在 GOV.UK Docker 环境中，您可以通过以下命令启动 Whitehall：

govuk-docker-run bundle exec rails server

2.2 创建内容

通过浏览器访问 Whitehall 的管理界面（例如：http://whitehall-admin.dev.gov.uk/government/admin/news/new），您可以创建和管理内容。

2.3 使用 Govspeak

Whitehall 使用 Govspeak 作为主要的发布格式。Govspeak 是一种基于 Markdown 的变体，用于简化内容的编写和格式化。

3. 项目 API 使用文档

Whitehall 提供了丰富的 API 接口，用于与其他系统进行集成。以下是 API 的基本使用方法：

3.1 获取内容列表

您可以通过以下 API 接口获取内容列表：

GET /government/admin/news

3.2 创建新内容

通过以下 API 接口可以创建新内容：

POST /government/admin/news/new

3.3 更新内容

通过以下 API 接口可以更新现有内容：

PUT /government/admin/news/{id}

4. 项目安装方式

Whitehall 的安装方式主要依赖于 GOV.UK Docker 环境。以下是详细的安装步骤：

4.1 安装依赖

在 GOV.UK Docker 环境中，您需要安装 Whitehall 的依赖：

govuk-docker-run bundle install

4.2 运行测试

您可以通过以下命令运行 Whitehall 的测试套件：

govuk-docker-run bundle exec rake

4.3 运行 JavaScript 测试

如果您需要单独运行 JavaScript 测试，可以使用以下命令：

govuk-docker-run bundle exec rake jasmine

结论

通过本文档，您应该能够顺利安装、使用和集成 Whitehall 项目。如果您在安装或使用过程中遇到任何问题，请参考 Whitehall 的官方文档或联系技术支持团队。