Iconify API 项目教程

1. 项目目录结构及介绍

Iconify API 是一个基于 Node.js 的 HTTP 服务器，它提供了图标数据服务，能够按需加载图标数据，并动态生成 SVG。项目的目录结构如下：

iconify/api
├── .github/              # GitHub 工作流和配置文件
├── icons/                # 自定义图标集目录
├── src/                  # 源代码目录
│   ├── config/           # 配置文件
│   ├── icons/            # 图标处理相关代码
│   ├── server/           # 服务器启动和HTTP处理相关代码
│   └── utils/            # 工具函数
├── .editorconfig          # 编辑器配置文件
├── .gitignore            # Git 忽略文件
├── .npmignore            # NPM 忽略文件
├── Dockerfile            # Docker 配置文件
├── README.md             # 项目说明文件
├── docker.sh             # Docker 启动脚本
├── license.txt           # 许可证文件
├── package-lock.json     # NPM 锁定文件
├── package.json          # NPM 包配置文件
└── tsconfig.json         # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动文件是 src/server/index.ts。该文件负责初始化和启动 HTTP 服务器。以下是启动文件的主要步骤：

• 引入必要的 Node.js 模块和项目配置。
• 创建 HTTP 服务器，并配置路由处理函数。
• 监听指定的端口，启动服务器。

启动服务器的命令通常是：

npm run start

该命令会执行 package.json 中定义的 start 脚本，该脚本会调用 Node.js 运行 src/server/index.ts 文件。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/app.ts。该文件定义了项目运行时的各种配置参数，包括：

• HOST: HTTP 服务器监听的 IP 地址或主机名。
• PORT: HTTP 服务器监听的端口号。
• ICONIFY_SOURCE: 图标数据源的配置，可以是 full、split 或 none。
• REDIRECT_INDEX: 根路由 / 的重定向地址。
• STATUS_REGION: /version 路由响应中的自定义文本。
• ENABLE_ICON_LISTS: 是否启用图标列表路由。
• ENABLE_SEARCH_ENGINE: 是否启用搜索引擎路由。
• ALLOW_FILTER_ICONS_BY_STYLE: 是否允许基于样式过滤图标。

这些配置可以通过环境变量进行覆盖，也可以在 .env 文件中设置。

在修改配置后，需要重新编译源代码并重启服务器以使配置生效。