iRail 项目技术文档

1. 安装指南

环境要求

• Node.js: 请确保已安装 Node.js。
• Composer: 请确保已安装 Composer。
• PHP 扩展: 请确保已安装 composer.json 文件中列出的所有 PHP 扩展。

安装步骤

1. 克隆仓库:

   git clone https://github.com/iRail/iRail.git
   cd iRail
   

2. 创建 .env 文件: 在项目根目录下创建一个 .env 文件，并填写以下配置：

   CACHE_DRIVER=apc
   NMBS_RIV_API_KEY=your_api_key
   GTFS_RANGE_DAYS_BACKWARDS=7
   GTFS_RANGE_DAYS_FORWARDS=7
   APP_TIMEZONE=EUROPE/BRUSSELS
   

3. 运行 Docker 容器: 使用 Docker Compose 启动服务：

   docker-compose up -d
   

4. 配置数据库:

   • 如果使用 MariaDB，请确保在 MariaDB 服务器上创建一个数据库，并确保数据库凭据与 docker-compose 文件中的配置一致。
   • 如果使用 SQLite，请调整数据库配置。

5. 运行数据库迁移:

   php artisan migrate
   

6. 访问 API: 在浏览器中访问 http://localhost:8080/，即可使用 iRail API。

2. 项目的使用说明

iRail 项目旨在为比利时的移动性数字创意提供支持，特别是铁路时刻表的可用性。项目提供了一个易于使用的移动网站，通过自有的 API 查询铁路时刻表。

主要功能

• 移动网站: 提供一个简单的移动网站，用于查询铁路时刻表。
• API: 提供 API 接口，供开发者使用。
• 原生应用: 支持 BeTrains 和 RailerApp 等原生应用。

使用场景

• 开发者: 可以通过 API 获取铁路时刻表数据，用于开发相关应用。
• 用户: 可以通过移动网站或原生应用查询铁路时刻表。

3. 项目 API 使用文档

API 文档

API 文档可以在 https://docs.irail.be 找到。以下是一些常用的 API 端点：

• 获取列车时刻表:

  GET /api/trains
  

• 获取车站列表:

  GET /api/stations
  

• 获取特定列车的详细信息:

  GET /api/trains/{trainId}
  

请求示例

curl -X GET "http://localhost:8080/api/trains"

响应示例

{
  "data": [
    {
      "trainId": "1234",
      "departureTime": "2023-10-01T12:00:00Z",
      "arrivalTime": "2023-10-01T14:00:00Z"
    }
  ]
}

4. 项目安装方式

使用 Docker 安装

1. 克隆仓库:

   git clone https://github.com/iRail/iRail.git
   cd iRail
   

2. 配置 .env 文件: 参考 安装指南 中的 .env 文件配置。

3. 启动 Docker 容器:

   docker-compose up -d
   

4. 访问 API: 在浏览器中访问 http://localhost:8080/，即可使用 iRail API。

手动安装

1. 克隆仓库:

   git clone https://github.com/iRail/iRail.git
   cd iRail
   

2. 安装依赖:

   composer install
   npm install
   

3. 配置 .env 文件: 参考 安装指南 中的 .env 文件配置。

4. 运行数据库迁移:

   php artisan migrate
   

5. 启动本地服务器:

   php artisan serve
   

6. 访问 API: 在浏览器中访问 http://localhost:8000/，即可使用 iRail API。

通过以上步骤，您可以成功安装并使用 iRail 项目。