three-geospatial 项目教程

three-geospatial 项目教程

three-geospatial Geospatial Rendering in Three.js 项目地址: https://gitcode.com/gh_mirrors/th/three-geospatial

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

three-geospatial 项目是一个基于 Three.js 的地理空间渲染原型，项目的目录结构如下：

• apps/: 包含独立的程序，如数据生成工具。
• data/: 存储生成数据所需的命令行应用程序。
• packages/: 存放可发布的 NPM 包，包括 atmosphere、clouds、core 和 effects 等模块。
• storybook/: 包含用于展示库功能的 Storybook 故事。
• .github/: 包含 GitHub 工作流文件。
• .vscode/: 包含 Visual Studio Code 的配置文件。
• editorconfig: 用于定义编辑器配置。
• eslintrc.json: ESLint 配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: 定义 Git 忽略的文件。
• LICENSE: 项目许可证文件。
• README.md: 项目自述文件。
• jest.config.ts: Jest 测试配置文件。
• jest.preset.js: Jest 预设配置文件。
• nx.json: Nx 工作区配置文件。
• package.json: 项目包配置文件。
• pnpm-lock.yaml: pnpm 锁文件。
• project.json: Nx 项目配置文件。
• tsconfig.base.json: TypeScript 基础配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 pnpm (Performant npm) 来进行的。以下是一些基本的启动命令：

• pnpm install: 安装项目依赖。
• pnpm build: 构建所有库和应用。
• pnpm build {name}: 构建指定的库或应用。
• pnpm test: 运行单元测试。
• pnpm lint: 运行代码检查。
• pnpm format-all: 使用 Prettier 格式化源代码。

要运行 Storybook，可以使用以下命令：

• nx storybook: 在本地运行 Storybook，默认端口为 4400。

3. 项目的配置文件介绍

项目的配置文件包括：

• .editorconfig: 用于定义项目中的编辑器设置，如缩进风格和换行符等。
• .eslintrc.json: ESLint 配置文件，用于定义代码质量和风格规则。
• jest.config.ts 和 jest.preset.js: Jest 配置文件，用于定义测试配置。
• nx.json: Nx 工作区配置文件，用于定义 Nx 相关的配置。
• project.json: Nx 项目配置文件，用于定义项目特定的配置。
• tsconfig.base.json: TypeScript 基础配置文件，用于定义 TypeScript 编译器的配置。

此外，项目可能需要的环境变量配置在根目录下的 .env 文件中，包括但不限于：

• STORYBOOK_GOOGLE_MAP_API_KEY: Google Maps API 密钥。
• STORYBOOK_ION_API_TOKEN: Cesium Ion API 访问令牌。

在开始之前，请确保正确配置了所有必要的环境变量。

three-geospatial Geospatial Rendering in Three.js 项目地址: https://gitcode.com/gh_mirrors/th/three-geospatial