GitHub City 项目安装与使用教程

1. 项目目录结构及介绍

GitHub City 项目的目录结构如下：

GithubCity/
├── assets/
├── github/
│   └── workflows/
├── husky/
├── .eslintrc.js
├── .gitignore
├── .prettierrc.js
├── .stylelintrc.js
├── LICENSE
├── README.md
├── algo.js
├── api.js
├── constants.js
├── favicon.svg
├── index.html
├── main.js
├── package-lock.json
├── package.json
├── scene.js
└── style.scss

目录结构介绍

• assets/: 存放项目所需的静态资源文件。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• husky/: 存放 Husky 的配置文件，用于 Git 钩子。
• .eslintrc.js: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置。
• .prettierrc.js: Prettier 配置文件，用于代码格式化。
• .stylelintrc.js: Stylelint 配置文件，用于样式代码检查。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• algo.js: 项目算法实现文件。
• api.js: 项目 API 接口实现文件。
• constants.js: 项目常量定义文件。
• favicon.svg: 项目图标文件。
• index.html: 项目主页 HTML 文件。
• main.js: 项目主逻辑文件。
• package-lock.json: 项目依赖锁定文件。
• package.json: 项目依赖配置文件。
• scene.js: 项目 3D 场景实现文件。
• style.scss: 项目样式文件。

2. 项目启动文件介绍

项目的启动文件是 main.js。该文件负责初始化 3D 场景，加载 GitHub 贡献数据，并生成 3D 城市模型。

main.js 文件介绍

• 初始化场景: 使用 Three.js 初始化 3D 场景。
• 加载数据: 从 GitHub API 获取用户的贡献数据。
• 生成城市模型: 根据贡献数据生成 3D 城市模型。

3. 项目的配置文件介绍

.eslintrc.js

ESLint 配置文件，用于定义代码风格检查规则。

.gitignore

Git 忽略文件配置，指定哪些文件和目录不需要被 Git 跟踪。

.prettierrc.js

Prettier 配置文件，用于定义代码格式化规则。

.stylelintrc.js

Stylelint 配置文件，用于定义样式代码检查规则。

package.json

项目依赖配置文件，包含项目的元数据和依赖包信息。

LICENSE

项目许可证文件，定义项目的开源许可证类型。

README.md

项目说明文档，包含项目的介绍、安装步骤和使用说明。

通过以上配置文件，可以确保项目的代码风格一致性，并方便开发者进行代码管理和维护。