GraphQL Landscape 项目启动与配置教程

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

graphql-landscape 项目是一个开源项目，旨在展示 GraphQL 生态系统，并展示 GraphQL 基金会的成员公司。项目的目录结构如下：

• .github/：包含与 GitHub 仓库操作相关的文件，例如工作流配置等。
• hosted_logos/：存储项目所包含的各个开源项目或公司的 SVG 格式 Logo。
• images/：可能包含项目所需的额外图片资源。
• .gitignore：指定在 Git 仓库中应该被忽略的文件和目录。
• LICENSE：项目的许可协议文件，本项目采用 Apache-2.0 许可。
• README.md：项目的自述文件，介绍项目的目的和功能。
• code-of-conduct.md：项目的行为准则文件。
• config.yml：项目的配置文件，包含一些基本的项目配置信息。
• landscape.yml：项目的核心数据文件，包含了生成 GraphQL Landscape 的所有数据。
• 其他可能存在的文件夹和文件。

2. 项目的启动文件介绍

本项目并没有一个传统意义上的“启动文件”，因为它不是一个可以直接运行的应用程序。它是一个数据集，用于生成 GraphQL 生态系统的可视化地图。要“启动”这个过程，你需要使用 landscape2 工具。

通常，你需要在本地安装 landscape2 工具，然后使用以下命令来构建和查看 Landscape：

landscape2 build --data-file landscape.yml --settings-url [你的 settings.yml 的 URL] --logos-path hosted_logos --output-dir build

然后，为了在本地预览结果，可以运行：

landscape2 serve --landscape-dir build

请注意，你需要替换 [你的 settings.yml 的 URL] 为实际可用的 URL。

3. 项目的配置文件介绍

项目中主要的配置文件是 config.yml 和 landscape.yml。

• config.yml：这个文件包含了项目的一些基本配置信息，例如项目的默认 Crunchbase 等。
• landscape.yml：这个文件是生成 GraphQL Landscape 的核心，包含了所有在地图上展示的开源项目和相关数据。如果你想要添加新的开源项目到 Landscape 中，你需要编辑这个文件，并且提交一个 pull request。

在编辑 landscape.yml 文件时，请确保遵循项目的规范，例如，新项目需要有一个 Logo，并且需要在 hosted_logos/ 目录下提供 SVG 格式的 Logo 文件。此外，项目的描述、GitHub 星标数等也需要正确填写。