@trapar-waves/react-three-maplibre 1.2.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,107 +9,78 @@
9
9
 
10
10
  ---
11
11
 
12
- [English](../README.md) | [日本語](/readme/README-JP.md) | [Русский язык](/readme/README-RU.md)
12
+ [English](../README.md) | [日本語](./README-JP.md) | [Русский язык](./README-RU.md)
13
13
 
14
- > 一个基于React的库,集成了Three.js、MapLibre和AntV,用于高级地理空间3D可视化。
14
+ > 一个基于 React 的库,集成了 Three.js、MapLibre AntV,用于高级地理空间 3D 可视化。
15
15
 
16
- ## ✨ 特性
16
+ ![react-three-maplibre hero](../assets/readme/hero.svg)
17
17
 
18
- - **地理空间可视化:** 结合`@antv/l7`和`maplibre-gl`,通过自定义地图图层实现强大的地理空间数据渲染。
19
- - **React 3D渲染:** 利用`@react-three/fiber`和`@react-three/drei`将Three.js集成到基于React的工作流中,实现声明式3D场景管理。
20
- - **可定制UI集成:** 提供与React(`react`、`react-dom`)的无缝集成,用于构建交互式地理空间应用。
21
- - **实用优先的样式:** 采用`tailwindcss`为组件和布局提供灵活快速的样式设计。
22
- - **类型安全:** 使用TypeScript确保类型安全,提升开发过程中的开发者体验。
23
- - **快速开发工作流:** 利用`rsbuild`实现优化构建和高效的开发服务器性能。
24
- - **丰富的组件库:** 与`three-stdlib`和`@react-three/drei`集成,提供可重用的Three.js工具和组件。
25
- - **地图交互性:** 实现`react-map-gl`,用于地理空间环境中的交互式地图控制和客户端导航。
26
- - **AntV增强功能:** 整合`@antv/l7-maps`,提供额外的地图分层功能和可视化工具。
18
+ ![Features](../assets/readme/headers/features.svg)
27
19
 
28
- ## 💻 技术栈
20
+ - **地理空间可视化:** 结合 `@antv/l7` 和 `maplibre-gl`,通过自定义地图图层实现强大的地理空间数据渲染。
21
+ - **React 3D 渲染:** 利用 `@react-three/fiber` 和 `@react-three/drei` 将 Three.js 集成到基于 React 的工作流中,实现声明式 3D 场景管理。
22
+ - **可定制 UI 集成:** 提供与 React(`react`、`react-dom`)的无缝集成,用于构建交互式地理空间应用。
23
+ - **实用优先的样式:** 采用 `tailwindcss` 为组件和布局提供灵活快速的样式设计。
24
+ - **类型安全:** 使用 TypeScript 确保类型安全,提升开发过程中的开发者体验。
25
+ - **快速开发工作流:** 利用 `rsbuild` 实现优化构建和高效的开发服务器性能。
26
+ - **丰富的组件库:** 与 `three-stdlib` 和 `@react-three/drei` 集成,提供可重用的 Three.js 工具和组件。
27
+ - **地图交互性:** 实现 `react-map-gl`,用于地理空间环境中的交互式地图控制和客户端导航。
28
+ - **AntV 增强功能:** 整合 `@antv/l7-maps`,提供额外的地图分层功能和可视化工具。
29
29
 
30
- - **框架/库:** React
31
- - **UI工具包/样式:** Tailwind CSS
32
- - **3D渲染:** Three.js(`@react-three/fiber`、`@react-three/drei`)
33
- - **地理空间库:** MapLibre GL、AntV L7
34
- - **构建工具:** Rsbuild
35
- - **语言:** TypeScript
30
+ ![Tech Stack](../assets/readme/headers/tech-stack.svg)
36
31
 
37
- 完整依赖列表参见[package.json](package.json)。
32
+ - **框架/库:** `React`
33
+ - **UI 工具包/样式:** `Tailwind CSS`
34
+ - **3D 渲染:** `Three.js`(`@react-three/fiber`、`@react-three/drei`)
35
+ - **地理空间库:** `MapLibre GL`、`AntV L7`
36
+ - **构建工具:** `Rsbuild`
37
+ - **语言:** `TypeScript`
38
38
 
39
- ## 🚀 开始使用
39
+ 查看 [package.json](../package.json) 获取完整的依赖列表。
40
40
 
41
- 按照以下说明在本地运行项目。
41
+ ![Getting Started](../assets/readme/headers/getting-started.svg)
42
42
 
43
- ### 前提条件
43
+ ## 前置条件
44
44
 
45
- 确保已安装以下软件:
45
+ - Node.js(推荐 >= 18.x)
46
+ - 包管理器(npm、yarn 或 pnpm)
46
47
 
47
- - Node.js (推荐 >= 18.x 版本)
48
- - 包管理器 (npm, yarn 或 pnpm)
49
-
50
- ```bash
51
- node -v
52
- npm -v
53
- ```
54
-
55
- ### 安装步骤
48
+ ### 安装
56
49
 
57
50
  1. 使用模板创建新项目:
58
51
 
59
- ```bash
60
- pnpm create trapar-waves
61
- ```
62
-
63
- 2. 进入项目目录并安装依赖:
64
-
65
- ```bash
66
- cd your-project-name
67
- pnpm install
68
- # or
69
- npm install
70
- # or
71
- yarn install
72
- ```
73
-
74
- ### 开发
52
+ ```bash
53
+ pnpm create trapar-waves
54
+ ```
75
55
 
76
- 启动带热重载的开发服务器:
56
+ 2. 导航到项目目录并安装依赖:
77
57
 
78
- ```bash
79
- pnpm dev
80
- # or
81
- npm run dev
82
- # or
83
- yarn dev
84
- ```
58
+ ```bash
59
+ pnpm install
60
+ ```
85
61
 
86
- 默认情况下,应用程序将在 `http://localhost:3000` 可用。
62
+ 3. 启动开发服务器:
87
63
 
88
- ### 构建生产版本
64
+ ```bash
65
+ pnpm dev
66
+ ```
89
67
 
90
- 创建生产构建:
68
+ ![Project Structure](../assets/readme/headers/project-structure.svg)
91
69
 
92
- ```bash
93
- pnpm build
94
- # or
95
- npm run build
96
- # or
97
- yarn build
98
70
  ```
99
-
100
- 在本地预览生产构建:
101
-
102
- ```bash
103
- pnpm preview
104
- # or
105
- npm run preview
106
- # or
107
- yarn preview
71
+ ├── public/ # 静态资源
72
+ ├── src/ # 源代码
73
+ │ ├── App.tsx # 主应用组件
74
+ │ └── index.tsx # 入口点
75
+ ├── rsbuild.config.ts # Rsbuild 配置
76
+ ├── tsconfig.json # TypeScript 配置
77
+ ├── eslint.config.js # ESLint 配置
78
+ └── package.json # 项目依赖和脚本
108
79
  ```
109
80
 
110
- ## 📦 使用方法
81
+ ![Usage](../assets/readme/headers/usage.svg)
111
82
 
112
- 该库被设计为用于创建地理空间3D可视化应用程序的模板。它提供了一个基础设置,包括 React、Three.js、MapLibre GL 和 AntV L7。
83
+ 该库被设计为用于创建地理空间 3D 可视化应用程序的模板。它提供了一个基础设置,包括 React、Three.js、MapLibre GL 和 AntV L7。
113
84
 
114
85
  ### 基本示例
115
86
 
@@ -222,25 +193,26 @@ export default App;
222
193
 
223
194
  模板默认使用无需 API Key 的 Carto GL 样式(见 `src/App.tsx` 中的 `MAP_STYLE_URL`)。若改用 MapTiler 等需鉴权的服务,请自行设置 `mapStyle` 并通过 `.env` / CI 密钥管理凭据。
224
195
 
225
- ## 🤝 贡献指南
196
+ ![Contributing](../assets/readme/headers/contributing.svg)
226
197
 
227
- 欢迎贡献,非常感谢您的支持!请按照以下步骤进行贡献:
198
+ 欢迎贡献,非常感谢!请按照以下步骤贡献:
228
199
 
229
- 1. Fork 本仓库
230
- 2. 创建功能分支(`git checkout -b feature/amazing-feature`)
231
- 3. 提交您的更改(`git commit -m 'Add some amazing feature'`)
200
+ 1. Fork 仓库
201
+ 2. 创建特性分支(`git checkout -b feature/amazing-feature`)
202
+ 3. 提交更改(`git commit -m 'Add some amazing feature'`)
232
203
  4. 推送到分支(`git push origin feature/amazing-feature`)
233
- 5. 打开Pull Request
204
+ 5. 创建 Pull Request
205
+
206
+ ![License](../assets/readme/headers/license.svg)
234
207
 
235
- 请确保您的代码遵循现有风格并通过所有测试。
208
+ MIT License © 2025 Trapar Waves
236
209
 
237
- ## 👤 Author
210
+ ## 👤 作者
238
211
 
239
- - **Rikka:** (admin@rikka.cc)
240
- - **GitHub Profile:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
212
+ - **Rikka:** [admin@rikka.cc](mailto:admin@rikka.cc)
213
+ - **GitHub 主页:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
241
214
 
242
- ## 🔗 Links
215
+ ## 🔗 链接
243
216
 
244
- - **仓库:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
245
- - **主页:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
246
- - **问题:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
217
+ - **仓库:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
218
+ - **Issues:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
@@ -9,107 +9,78 @@
9
9
 
10
10
  ---
11
11
 
12
- [English](../README.md) | [中文](/readme/README-CN.md) | [Русский язык](/readme/README-RU.md)
12
+ [English](../README.md) | [中文](./README-CN.md) | [Русский язык](./README-RU.md)
13
13
 
14
- > Three.js、MapLibre、AntVを統合したReactベースのライブラリで、高度な地理空間3D可視化を実現します。
14
+ > Three.js、MapLibre、AntV を統合した React ベースのライブラリで、高度な地理空間 3D 可視化を実現します。
15
15
 
16
- ## ✨ 特徴
16
+ ![react-three-maplibre hero](../assets/readme/hero.svg)
17
17
 
18
- - **地理空間可視化:** `@antv/l7`と`maplibre-gl`を組み合わせ、カスタムマップレイヤーを使用した強力な地理空間データレンダリングを実現します。
19
- - **Reactによる3Dレンダリング:** `@react-three/fiber`と`@react-three/drei`を活用し、Three.jsをReactベースのワークフローに統合し、宣言型3Dシーン管理を実現します。
20
- - **カスタマイズ可能なUI統合:** React(`react`、`react-dom`)とのシームレスな統合を提供し、インタラクティブな地理空間アプリケーションを構築します。
21
- - **ユーティリティファーストのスタイリング:** `tailwindcss`を採用し、コンポーネントとレイアウトの柔軟で迅速なスタイリングを実現します。
22
- - **型安全性:** TypeScriptを使用して型安全性を確保し、開発中の開発者エクスペリエンスを向上させます。
23
- - **高速開発ワークフロー:** `rsbuild`を活用して最適化されたビルドと効率的な開発サーバーパフォーマンスを実現します。
24
- - **充実したコンポーネントライブラリ:** `three-stdlib`および`@react-three/drei`と統合し、再利用可能なThree.jsユーティリティとコンポーネントを提供します。
25
- - **マップインタラクティビティ:** `react-map-gl`を実装し、地理空間コンテキストにおけるインタラクティブなマップコントロールとクライアント側ナビゲーションを提供します。
26
- - **AntV拡張機能:** `@antv/l7-maps`を組み込み、追加のマップレイヤリング機能と可視化ツールを提供します。
18
+ ![Features](../assets/readme/headers/features.svg)
27
19
 
28
- ## 💻 技術スタック
20
+ - **地理空間可視化:** `@antv/l7` と `maplibre-gl` を組み合わせ、カスタムマップレイヤーを使用した強力な地理空間データレンダリングを実現します。
21
+ - **React による 3D レンダリング:** `@react-three/fiber` と `@react-three/drei` を活用し、Three.js を React ベースのワークフローに統合し、宣言型 3D シーン管理を実現します。
22
+ - **カスタマイズ可能な UI 統合:** React(`react`、`react-dom`)とのシームレスな統合を提供し、インタラクティブな地理空間アプリケーションを構築します。
23
+ - **ユーティリティファーストのスタイリング:** `tailwindcss` を採用し、コンポーネントとレイアウトの柔軟で迅速なスタイリングを実現します。
24
+ - **型安全性:** TypeScript を使用して型安全性を確保し、開発中の開発者エクスペリエンスを向上させます。
25
+ - **高速開発ワークフロー:** `rsbuild` を活用して最適化されたビルドと効率的な開発サーバーパフォーマンスを実現します。
26
+ - **充実したコンポーネントライブラリ:** `three-stdlib` および `@react-three/drei` と統合し、再利用可能な Three.js ユーティリティとコンポーネントを提供します。
27
+ - **マップインタラクティビティ:** `react-map-gl` を実装し、地理空間コンテキストにおけるインタラクティブなマップコントロールとクライアント側ナビゲーションを提供します。
28
+ - **AntV 拡張機能:** `@antv/l7-maps` を組み込み、追加のマップレイヤリング機能と可視化ツールを提供します。
29
29
 
30
- - **フレームワーク/ライブラリ:** React
31
- - **UIツールキット/スタイリング:** Tailwind CSS
32
- - **3Dレンダリング:** Three.js(`@react-three/fiber`、`@react-three/drei`)
33
- - **地理空間ライブラリ:** MapLibre GL、AntV L7
34
- - **ビルドツール:** Rsbuild
35
- - **言語:** TypeScript
30
+ ![Tech Stack](../assets/readme/headers/tech-stack.svg)
36
31
 
37
- 依存関係の完全なリストについては[package.json](package.json)を参照してください。
32
+ - **フレームワーク/ライブラリ:** `React`
33
+ - **UI ツールキット/スタイリング:** `Tailwind CSS`
34
+ - **3D レンダリング:** `Three.js`(`@react-three/fiber`、`@react-three/drei`)
35
+ - **地理空間ライブラリ:** `MapLibre GL`、`AntV L7`
36
+ - **ビルドツール:** `Rsbuild`
37
+ - **言語:** `TypeScript`
38
38
 
39
- ## 🚀 始め方
39
+ 依存関係の完全なリストについては [package.json](../package.json) を参照してください。
40
40
 
41
- 以下の手順に従ってプロジェクトをローカルで実行してください。
41
+ ![Getting Started](../assets/readme/headers/getting-started.svg)
42
42
 
43
- ### 前提条件
43
+ ## 前提条件
44
44
 
45
- 以下がインストールされていることを確認してください:
46
-
47
- - Node.js (推奨バージョン >= 18.x)
48
- - パッケージマネージャー (npm, yarn または pnpm)
49
-
50
- ```bash
51
- node -v
52
- npm -v
53
- ```
45
+ - Node.js(>= 18.x 推奨)
46
+ - パッケージマネージャー(npm、yarn、または pnpm)
54
47
 
55
48
  ### インストール
56
49
 
57
- 1. テンプレートを使用して新しいプロジェクトを作成します:
58
-
59
- ```bash
60
- pnpm create trapar-waves
61
- ```
62
-
63
- 2. プロジェクトディレクトリに移動し、依存関係をインストールします:
50
+ 1. テンプレートを使用して新しいプロジェクトを作成:
64
51
 
65
- ```bash
66
- cd your-project-name
67
- pnpm install
68
- # or
69
- npm install
70
- # or
71
- yarn install
72
- ```
73
-
74
- ### 開発
52
+ ```bash
53
+ pnpm create trapar-waves
54
+ ```
75
55
 
76
- ホットリロード付きの開発サーバーを起動します:
56
+ 2. プロジェクトディレクトリに移動し、依存関係をインストール:
77
57
 
78
- ```bash
79
- pnpm dev
80
- # or
81
- npm run dev
82
- # or
83
- yarn dev
84
- ```
58
+ ```bash
59
+ pnpm install
60
+ ```
85
61
 
86
- アプリケーションはデフォルトで `http://localhost:3000` で利用可能です。
62
+ 3. 開発サーバーを起動:
87
63
 
88
- ### 本番用ビルド
64
+ ```bash
65
+ pnpm dev
66
+ ```
89
67
 
90
- 本番用のビルドを作成します:
68
+ ![Project Structure](../assets/readme/headers/project-structure.svg)
91
69
 
92
- ```bash
93
- pnpm build
94
- # or
95
- npm run build
96
- # or
97
- yarn build
98
70
  ```
99
-
100
- ローカルで本番ビルドをプレビューします:
101
-
102
- ```bash
103
- pnpm preview
104
- # or
105
- npm run preview
106
- # or
107
- yarn preview
71
+ ├── public/ # 静的アセット
72
+ ├── src/ # ソースコード
73
+ │ ├── App.tsx # メインアプリケーションコンポーネント
74
+ │ └── index.tsx # エントリーポイント
75
+ ├── rsbuild.config.ts # Rsbuild 設定
76
+ ├── tsconfig.json # TypeScript 設定
77
+ ├── eslint.config.js # ESLint 設定
78
+ └── package.json # プロジェクトの依存関係とスクリプト
108
79
  ```
109
80
 
110
- ## 📦 使用方法
81
+ ![Usage](../assets/readme/headers/usage.svg)
111
82
 
112
- このライブラリは、地理空間3D可視化アプリケーションを作成するためのテンプレートとして設計されています。React、Three.js、MapLibre GL、AntV L7を使用した基本的なセットアップを提供します。
83
+ このライブラリは、地理空間 3D 可視化アプリケーションを作成するためのテンプレートとして設計されています。React、Three.js、MapLibre GL、AntV L7 を使用した基本的なセットアップを提供します。
113
84
 
114
85
  ### 基本的な例
115
86
 
@@ -222,25 +193,26 @@ export default App;
222
193
 
223
194
  テンプレートは API キー不要の Carto GL スタイル(`src/App.tsx` の `MAP_STYLE_URL`)を既定とします。MapTiler など別プロバイダへ切り替える場合は `mapStyle` を変更し、`.env` / CI で鍵を管理してください。
224
195
 
225
- ## 🤝 コントリビューション
196
+ ![Contributing](../assets/readme/headers/contributing.svg)
197
+
198
+ コントリビュートを歓迎します!以下の手順に従ってコントリビュートしてください:
226
199
 
227
- 貢献は歓迎され、非常に高く評価されています!貢献するには以下の手順に従ってください:
200
+ 1. リポジトリをフォーク
201
+ 2. 機能ブランチを作成(`git checkout -b feature/amazing-feature`)
202
+ 3. 変更をコミット(`git commit -m 'Add some amazing feature'`)
203
+ 4. ブランチにプッシュ(`git push origin feature/amazing-feature`)
204
+ 5. Pull Request を作成
228
205
 
229
- 1. リポジトリをフォークする
230
- 2. 機能ブランチを作成する(`git checkout -b feature/amazing-feature`)
231
- 3. 変更をコミットする(`git commit -m 'Add some amazing feature'`)
232
- 4. ブランチにプッシュする(`git push origin feature/amazing-feature`)
233
- 5. Pull Requestを開く
206
+ ![License](../assets/readme/headers/license.svg)
234
207
 
235
- コードが既存のスタイルに従い、すべてのテストに合格することを確認してください。
208
+ MIT License © 2025 Trapar Waves
236
209
 
237
- ## 👤 Author
210
+ ## 👤 作者
238
211
 
239
- - **Rikka:** (admin@rikka.cc)
240
- - **GitHub Profile:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
212
+ - **Rikka:** [admin@rikka.cc](mailto:admin@rikka.cc)
213
+ - **GitHub プロフィール:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
241
214
 
242
- ## 🔗 Links
215
+ ## 🔗 リンク
243
216
 
244
- - **リポジトリ:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
245
- - **ホームページ:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
246
- - **イシュー:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
217
+ - **リポジトリ:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
218
+ - **Issues:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
@@ -9,105 +9,76 @@
9
9
 
10
10
  ---
11
11
 
12
- [English](../README.md) | [中文](/readme/README-CN.md) | [日本語](/readme/README-JP.md)
12
+ [English](../README.md) | [中文](./README-CN.md) | [日本語](./README-JP.md)
13
13
 
14
14
  > Библиотека на базе React, интегрирующая Three.js, MapLibre и AntV для расширенной геопространственной 3D-визуализации.
15
15
 
16
- ## ✨ Особенности
16
+ ![react-three-maplibre hero](../assets/readme/hero.svg)
17
+
18
+ ![Features](../assets/readme/headers/features.svg)
17
19
 
18
20
  - **Геопространственная визуализация:** Комбинирует `@antv/l7` и `maplibre-gl` для мощного рендеринга геопространственных данных с пользовательскими слоями карт.
19
21
  - **3D-рендеринг с React:** Использует `@react-three/fiber` и `@react-three/drei` для интеграции Three.js в рабочий процесс на базе React для декларативного управления 3D-сценами.
20
22
  - **Интеграция настраиваемого UI:** Обеспечивает бесперебойную интеграцию с React (`react`, `react-dom`) для создания интерактивных геопространственных приложений.
21
23
  - **Стилизация с упором на утилиты:** Применяет `tailwindcss` для гибкой и быстрой стилизации компонентов и макетов.
22
- - **Типовая безопасность:** Использует TypeScript для обеспечения типовой безопасности и улучшения опыта разработчика во время разработки.
24
+ - **Типобезопасность:** Использует TypeScript для обеспечения типобезопасности и улучшения опыта разработчика во время разработки.
23
25
  - **Быстрый рабочий процесс разработки:** Использует `rsbuild` для оптимизированных сборок и эффективной производительности сервера разработки.
24
26
  - **Богатая библиотека компонентов:** Интегрируется с `three-stdlib` и `@react-three/drei` для переиспользуемых утилит и компонентов Three.js.
25
27
  - **Интерактивность карт:** Реализует `react-map-gl` для интерактивных элементов управления картами и навигации на клиентской стороне в геопространственных контекстах.
26
28
  - **Дополнения AntV:** Включает `@antv/l7-maps` для дополнительных возможностей слоев карт и инструментов визуализации.
27
29
 
28
- ## 💻 Технологический стек
29
-
30
- - **Фреймворк/Библиотека:** React
31
- - **UI-тулкит/Стилизация:** Tailwind CSS
32
- - **3D-рендеринг:** Three.js (`@react-three/fiber`, `@react-three/drei`)
33
- - **Геопространственные библиотеки:** MapLibre GL, AntV L7
34
- - **Инструмент сборки:** Rsbuild
35
- - **Язык:** TypeScript
30
+ ![Tech Stack](../assets/readme/headers/tech-stack.svg)
36
31
 
37
- Полный список зависимостей см. в [package.json](package.json).
32
+ - **Фреймворк/библиотека:** `React`
33
+ - **UI-тулкит/стилизация:** `Tailwind CSS`
34
+ - **3D-рендеринг:** `Three.js` (`@react-three/fiber`, `@react-three/drei`)
35
+ - **Геопространственные библиотеки:** `MapLibre GL`, `AntV L7`
36
+ - **Инструмент сборки:** `Rsbuild`
37
+ - **Язык:** `TypeScript`
38
38
 
39
- ## 🚀 Начало работы
39
+ Полный список зависимостей смотрите в [package.json](../package.json).
40
40
 
41
- Следуйте этим инструкциям, чтобы запустить проект локально.
41
+ ![Getting Started](../assets/readme/headers/getting-started.svg)
42
42
 
43
- ### Предварительные требования
43
+ ## Предварительные требования
44
44
 
45
- Убедитесь, что у вас установлены следующие компоненты:
46
-
47
- - Node.js (рекомендуется версия >= 18.x)
48
- - Пакетный менеджер (npm, yarn или pnpm)
49
-
50
- ```bash
51
- node -v
52
- npm -v
53
- ```
45
+ - Node.js (рекомендуется >= 18.x)
46
+ - Менеджер пакетов (npm, yarn или pnpm)
54
47
 
55
48
  ### Установка
56
49
 
57
50
  1. Создайте новый проект с помощью шаблона:
58
51
 
59
- ```bash
60
- pnpm create trapar-waves
61
- ```
62
-
63
- 2. Перейдите в каталог вашего проекта и установите зависимости:
52
+ ```bash
53
+ pnpm create trapar-waves
54
+ ```
64
55
 
65
- ```bash
66
- cd your-project-name
67
- pnpm install
68
- # or
69
- npm install
70
- # or
71
- yarn install
72
- ```
73
-
74
- ### Разработка
56
+ 2. Перейдите в директорию проекта и установите зависимости:
75
57
 
76
- Запустите сервер разработки с горячей перезагрузкой:
77
-
78
- ```bash
79
- pnpm dev
80
- # or
81
- npm run dev
82
- # or
83
- yarn dev
84
- ```
58
+ ```bash
59
+ pnpm install
60
+ ```
85
61
 
86
- Приложение будет доступно по адресу `http://localhost:3000` по умолчанию.
62
+ 3. Запустите сервер разработки:
87
63
 
88
- ### Сборка для продакшена
64
+ ```bash
65
+ pnpm dev
66
+ ```
89
67
 
90
- Чтобы создать сборку для продакшена:
68
+ ![Project Structure](../assets/readme/headers/project-structure.svg)
91
69
 
92
- ```bash
93
- pnpm build
94
- # or
95
- npm run build
96
- # or
97
- yarn build
98
70
  ```
99
-
100
- Предварительный просмотр сборки продакшена локально:
101
-
102
- ```bash
103
- pnpm preview
104
- # or
105
- npm run preview
106
- # or
107
- yarn preview
71
+ ├── public/ # Статические ресурсы
72
+ ├── src/ # Исходный код
73
+ │ ├── App.tsx # Основной компонент приложения
74
+ │ └── index.tsx # Точка входа
75
+ ├── rsbuild.config.ts # Конфигурация Rsbuild
76
+ ├── tsconfig.json # Конфигурация TypeScript
77
+ ├── eslint.config.js # Конфигурация ESLint
78
+ └── package.json # Зависимости и скрипты проекта
108
79
  ```
109
80
 
110
- ## 📦 Использование
81
+ ![Usage](../assets/readme/headers/usage.svg)
111
82
 
112
83
  Эта библиотека предназначена для использования в качестве шаблона для создания приложений геопространственной 3D-визуализации. Она предоставляет фундаментальную настройку с React, Three.js, MapLibre GL и AntV L7.
113
84
 
@@ -222,7 +193,7 @@ export default App;
222
193
 
223
194
  В шаблоне по умолчанию используется стиль Carto GL без API-ключа (`MAP_STYLE_URL` в `src/App.tsx`). Для другого провайдера (например, MapTiler) задайте `mapStyle` и храните ключи в `.env` / CI.
224
195
 
225
- ## 🤝 Участие в разработке
196
+ ![Contributing](../assets/readme/headers/contributing.svg)
226
197
 
227
198
  Вклад в проект приветствуется и очень ценится! Чтобы внести вклад, следуйте этим шагам:
228
199
 
@@ -232,15 +203,16 @@ export default App;
232
203
  4. Отправьте изменения в ветку (`git push origin feature/amazing-feature`)
233
204
  5. Откройте Pull Request
234
205
 
235
- Пожалуйста, убедитесь, что ваш код соответствует существующему стилю и проходит все тесты.
206
+ ![License](../assets/readme/headers/license.svg)
207
+
208
+ MIT License © 2025 Trapar Waves
236
209
 
237
- ## 👤 Author
210
+ ## 👤 Автор
238
211
 
239
- - **Rikka:** (admin@rikka.cc)
240
- - **GitHub Profile:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
212
+ - **Rikka:** [admin@rikka.cc](mailto:admin@rikka.cc)
213
+ - **Профиль GitHub:** [Muromi-Rikka](https://github.com/Muromi-Rikka)
241
214
 
242
- ## 🔗 Links
215
+ ## 🔗 Ссылки
243
216
 
244
217
  - **Репозиторий:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
245
- - **Домашняя страница:** [https://github.com/Trapar-waves/react-three-maplibre](https://github.com/Trapar-waves/react-three-maplibre)
246
- - **Проблемы:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
218
+ - **Issues:** [https://github.com/Trapar-waves/react-three-maplibre/issues](https://github.com/Trapar-waves/react-three-maplibre/issues)
package/rsbuild.config.ts CHANGED
@@ -1,9 +1,9 @@
1
- import process from "node:process";
2
1
  import { defineConfig, loadEnv } from "@rsbuild/core";
3
2
  import { pluginLess } from "@rsbuild/plugin-less";
4
3
  import { pluginReact } from "@rsbuild/plugin-react";
5
4
  import { RsdoctorRspackPlugin } from "@rsdoctor/rspack-plugin";
6
5
  import tailwind from "@tailwindcss/postcss";
6
+ import process from "node:process";
7
7
  import TurboConsole from "unplugin-turbo-console/rspack";
8
8
 
9
9
  const { publicVars } = loadEnv({ cwd: "./environments" });
@@ -18,20 +18,18 @@ function normalizeBasePath(): string {
18
18
  }
19
19
 
20
20
  const basePath = normalizeBasePath();
21
- const useSubpath = basePath !== "/";
21
+ const isUseSubpath = basePath !== "/";
22
22
 
23
- const enableRsdoctor = Boolean(process.env.RSDOCTOR);
24
- const enableTurboConsole = process.env.NODE_ENV === "development";
23
+ const isEnableRsdoctor = Boolean(process.env.RSDOCTOR);
24
+ const isEnableTurboConsole = process.env.NODE_ENV === "development";
25
25
 
26
26
  export default defineConfig({
27
- ...(useSubpath
28
- ? {
29
- server: { base: basePath },
30
- output: { assetPrefix: basePath },
31
- }
32
- : {}),
27
+ ...(isUseSubpath && {
28
+ output: { assetPrefix: basePath },
29
+ server: { base: basePath },
30
+ }),
33
31
  performance: {
34
- ...(enableRsdoctor ? { buildCache: false } : {}),
32
+ ...(isEnableRsdoctor && { buildCache: false }),
35
33
  },
36
34
  plugins: [pluginReact(), pluginLess()],
37
35
  source: {
@@ -45,10 +43,10 @@ export default defineConfig({
45
43
  },
46
44
  rspack: [
47
45
  (config) => {
48
- if (enableTurboConsole) {
46
+ if (isEnableTurboConsole) {
49
47
  config.plugins.push(TurboConsole());
50
48
  }
51
- if (enableRsdoctor) {
49
+ if (isEnableRsdoctor) {
52
50
  config.plugins.push(
53
51
  new RsdoctorRspackPlugin({
54
52
  output: {