gralobe 1.0.0 → 1.0.1
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.
- package/README.md +30 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
# Gralobe
|
|
2
2
|
|
|
3
|
+
> **NPM Package created as part of a submission to [TechArena Finland Hackathon](https://platform.techarena-finland.hackathon.com)**
|
|
4
|
+
|
|
3
5
|
Interactive 3D globe visualization with world statistics, smooth flat map ↔ globe transitions, and country labels.
|
|
4
6
|
|
|
7
|
+
[](https://www.npmjs.com/package/gralobe)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
|
|
5
10
|
## Features
|
|
6
11
|
|
|
7
12
|
- Smooth morphing animation between flat (Mercator) map and 3D globe
|
|
@@ -13,6 +18,10 @@ Interactive 3D globe visualization with world statistics, smooth flat map ↔ gl
|
|
|
13
18
|
- Height extrusion based on data values
|
|
14
19
|
- Fully typed TypeScript API
|
|
15
20
|
|
|
21
|
+
## Demo
|
|
22
|
+
|
|
23
|
+
See `video_demo_1_compressed.mp4` in this repository for a demonstration.
|
|
24
|
+
|
|
16
25
|
## Installation
|
|
17
26
|
|
|
18
27
|
```bash
|
|
@@ -235,6 +244,22 @@ import type {
|
|
|
235
244
|
} from 'gralobe';
|
|
236
245
|
```
|
|
237
246
|
|
|
247
|
+
## Development
|
|
248
|
+
|
|
249
|
+
```bash
|
|
250
|
+
# Install dependencies
|
|
251
|
+
npm install
|
|
252
|
+
|
|
253
|
+
# Run development server
|
|
254
|
+
npm run dev
|
|
255
|
+
|
|
256
|
+
# Build library
|
|
257
|
+
npm run build:lib
|
|
258
|
+
|
|
259
|
+
# Build demo app
|
|
260
|
+
npm run build
|
|
261
|
+
```
|
|
262
|
+
|
|
238
263
|
## Browser Support
|
|
239
264
|
|
|
240
265
|
Gralobe requires WebGL support. It works in all modern browsers:
|
|
@@ -247,9 +272,13 @@ Gralobe requires WebGL support. It works in all modern browsers:
|
|
|
247
272
|
## Dependencies
|
|
248
273
|
|
|
249
274
|
- [three.js](https://threejs.org/) - 3D rendering
|
|
250
|
-
- [
|
|
275
|
+
- [GSAP](https://greensock.com/gsap/) - Animations
|
|
251
276
|
- [lil-gui](https://github.com/georgealways/lil-gui) - Control panel
|
|
252
277
|
|
|
253
278
|
## License
|
|
254
279
|
|
|
255
280
|
MIT
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
**Created for [TechArena Finland Hackathon](https://platform.techarena-finland.hackathon.com)**
|
package/package.json
CHANGED