README.md 2.09 KB
Newer Older
Joe T.S.'s avatar
Joe T.S. committed
1
2
# 3DGeoVolumesAPI

Joe TS Dell's avatar
upload    
Joe TS Dell committed
3
4
5
6
7
8
9
10
11
12
13
14
### Live Demo: https://steinbeis-3dps.eu/3DGeoVolumes/
![Steinbeis GeoVolumes API](./img/ResourceArchitecture2.jpg)

## Installation

Use the package manager [npm](https://npmjs.com/) to install 3D GeoVolumes API.

```bash
npm install
```

## Usage
Joe TS Dell's avatar
update    
Joe TS Dell committed
15
16
### Starting server
1. Run `node server.js` (or any node manager - pm2/ nodemon) at your project folder.
JOE XMG's avatar
update    
JOE XMG committed
17
2. Access to the GeoVolumes
Joe TS Dell's avatar
update    
Joe TS Dell committed
18
19
20
21
   * **Landing Page**:  `http://localhost:port`
   * **Collections**: `http://localhost:port/collections`
   * **Collections with bbox filter**: `http://localhost:port/collections?bbox=minx,miny,maxx,maxy`

Joe TS Dell's avatar
update    
Joe TS Dell committed
22
### Adding Collection Contents
Joe TS Dell's avatar
update    
Joe TS Dell committed
23
* Add contents to `3DGeoVolumes\collections\collections.json` 
JOE XMG's avatar
update    
JOE XMG committed
24
25
26
27
* The 3D contents may be added directly in the collection folder or linked as HREF to the original source.
  * tileset.json (Cesium 3D Tiles)
  * i3s service json (ESRI Scene index)
  * gltf (direct file)
Joe TS Dell's avatar
update    
Joe TS Dell committed
28
29
30

### Configuration
* Port can be adjusted in the `server.js` file. 
Joe TS Dell's avatar
upload    
Joe TS Dell committed
31
32
33
34
35
36

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Joe TS Dell's avatar
up    
Joe TS Dell committed
37
38
39
## Author 
Joe Thunyathep Santhanavanich 

JOE XMG's avatar
update    
JOE XMG committed
40
41
42
Get in touch: https://www.linkedin.com/in/thunyatheps/

`Akademischer Mitarbeiter,
Joe TS Dell's avatar
up    
Joe TS Dell committed
43
44
Faculty of Geomatics, Computer Science and Mathematics,
University of Applied Sciences Stuttgart, Schellingstr. 24, D-70174 Stuttgart
JOE XMG's avatar
update    
JOE XMG committed
45
https://www.hft-stuttgart.de/p/thunyathep-santhanavanich`
Joe TS Dell's avatar
upload    
Joe TS Dell committed
46
47
48
49
50
51

## Link
| Document                                                         | URL                                 |
|------------------------------------------------------------------|-------------------------------------|
| 3D Data Container and Tiles API Pilot Summary Engineering Report | http://docs.ogc.org/per/20-031.html |
| Interoperable Simulation and Gaming Sprint Engineering Report    | http://docs.ogc.org/per/20-087.html |
Joe T.S.'s avatar
Joe T.S. committed
52
53
54
55
56
57
| Steinbeis Demo                                                   | https://steinbeis-3dps.eu |

## Citation
```
Santhanavanich, Thunyathep. (2021). OGC 3D GeoVolumes API. Zenodo. https://doi.org/10.5281/zenodo.5731579
```