Pelias 开源项目使用教程

1. 项目的目录结构及介绍

Pelias 项目的目录结构如下：

pelias/
├── Dockerfile
├── LICENSE
├── README.md
├── api/
├── cmd/
├── composer.json
├── config/
├── docker/
├── docs/
├── examples/
├── package.json
├── scripts/
├── setup.sh
├── test/
└── wof-admin-lookup/

目录介绍

• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的基本介绍和使用说明。
• api/: 包含 Pelias API 的代码。
• cmd/: 包含项目的命令行工具。
• composer.json: PHP 依赖管理文件。
• config/: 包含项目的配置文件。
• docker/: 包含 Docker 相关的文件和脚本。
• docs/: 包含项目的文档。
• examples/: 包含使用示例。
• package.json: Node.js 依赖管理文件。
• scripts/: 包含项目的脚本文件。
• setup.sh: 项目设置脚本。
• test/: 包含项目的测试代码。
• wof-admin-lookup/: 包含行政区域查找的相关代码。

2. 项目的启动文件介绍

Pelias 项目的启动文件主要集中在 api/ 目录下。以下是一些关键的启动文件：

• api/index.js: 这是 Pelias API 的主入口文件，负责启动 API 服务。
• api/server.js: 包含 API 服务器的配置和启动逻辑。
• api/routes/: 包含 API 的路由配置。

启动步骤

1. 确保已经安装了 Node.js 和 Docker。
2. 进入 api/ 目录。
3. 运行 npm install 安装依赖。
4. 运行 npm start 启动 API 服务。

3. 项目的配置文件介绍

Pelias 项目的配置文件主要位于 config/ 目录下。以下是一些关键的配置文件：

• config/default.json: 默认配置文件，包含所有模块的默认配置。
• config/local.json: 本地配置文件，可以覆盖默认配置。
• config/test.json: 测试配置文件，用于测试环境。

配置文件示例

{
  "esclient": {
    "hosts": [
      {
        "host": "localhost",
        "port": 9200
      }
    ]
  },
  "api": {
    "services": {
      "placeholder": {
        "url": "http://placeholder:4100"
      },
      "pip": {
        "url": "http://pip:4200"
      },
      "interpolation": {
        "url": "http://interpolation:4300"
      }
    }
  }
}

配置步骤

1. 根据需要修改 config/local.json 文件。
2. 确保配置文件中的服务地址和端口正确。
3. 重新启动 Pelias API 服务以应用新的配置。

通过以上步骤，您可以成功配置和启动 Pelias 开源项目。