TransitScreen 项目技术文档

1. 安装指南

环境要求

• PHP
• PostgreSQL 数据库
• Code Igniter 平台

安装步骤

1. 克隆项目代码：

   git clone https://github.com/MobilityLab/TransitScreen.git
   

2. 安装依赖：

   • 确保系统中已安装 PHP 和 PostgreSQL。
   • 使用 Composer 安装 PHP 依赖（如果需要）。

3. 配置数据库：

   • 创建一个新的 PostgreSQL 数据库。
   • 导入数据库 schema：

     psql -d your_database_name -f schema.sql
     

4. 配置文件调整：

   • 根据你的操作系统，调整配置文件以确保项目能够正确运行。配置文件通常包括数据库连接信息、API 密钥等。

2. 项目的使用说明

启动项目

1. 启动 Web 服务器：

   • 使用 PHP 内置服务器或其他 Web 服务器（如 Apache 或 Nginx）启动项目。

   php -S localhost:8000
   

2. 访问项目：

   • 打开浏览器，访问 http://localhost:8000 即可查看 TransitScreen 的实时显示界面。

功能说明

• 实时公交信息：显示多个公交公司（如 Metro、Metrobus、Circulator 等）的实时到站信息。
• 共享单车可用性：显示共享单车（如 Capital Bikeshare）的可用性信息。
• 高对比度设计：界面设计信息密集、高对比度，确保信息清晰易读。

3. 项目 API 使用文档

API 接口

• 获取公交到站信息：

  • 接口地址：/api/transit/arrivals
  • 请求方式：GET
  • 参数：
    • stop_id：公交站点 ID
    • agency_id：公交公司 ID
  • 返回数据：

    {
      "stop_id": "12345",
      "agency_id": "Metro",
      "arrivals": [
        {
          "route": "Red Line",
          "destination": "Shady Grove",
          "arrival_time": "2023-10-01 12:30:00"
        }
      ]
    }
    

• 获取共享单车可用性：

  • 接口地址：/api/bikeshare/availability
  • 请求方式：GET
  • 参数：
    • station_id：共享单车站点 ID
  • 返回数据：

    {
      "station_id": "67890",
      "bikes_available": 5,
      "docks_available": 10
    }
    

4. 项目安装方式

手动安装

1. 下载项目代码：

   git clone https://github.com/MobilityLab/TransitScreen.git
   

2. 配置环境：

   • 安装 PHP 和 PostgreSQL。
   • 配置数据库连接信息。

3. 启动项目：

   php -S localhost:8000
   

自动化安装（可选）

• 使用 Docker 进行自动化安装：
  1. 构建 Docker 镜像：

     docker build -t transitscreen .
     

  2. 运行 Docker 容器：

     docker run -p 8000:8000 transitscreen
     

通过以上步骤，你可以顺利安装并使用 TransitScreen 项目，享受实时公交和共享单车信息的便捷服务。