diff --git a/README.md b/README.md index 41fb3e249d61f3452929b6c1197eef7d743084ea..241b1842236c93aba37c2ba12faaf6b948938147 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,19 @@ npm install ``` ## Usage - -```bash -node server.js -``` +### Starting server +1. Run `node server.js` (or any node manager - pm2/ nodemon) at your project folder. +2. Access to the GeoVolumes Landing Page at http://localhost:port. + * **Landing Page**: `http://localhost:port` + * **Collections**: `http://localhost:port/collections` + * **Collections with bbox filter**: `http://localhost:port/collections?bbox=minx,miny,maxx,maxy` + +### Adding Collection +* Add contents to `3DGeoVolumes\collections\collections.json` +* Add contents to `3DGeoVolumes\collections\:collectionId\collectionId.json` (The automated script could be added here in future.) + +### Configuration +* Port can be adjusted in the `server.js` file. ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.