Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

= Make setup more clear #9

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

= Make setup more clear #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 13 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,23 @@ If you are not sure what appropriate values are, have a look [here](http://www.m

Besides publishing the GeoJSON tiles, you can also retrieve the protobuf encoded vector tiles by replacing the `geojson` extension with `mvt`, e.g. [http://localhost:8123/layer1/z/x/y.mvt](http://localhost:8123/layer1/z/x/y.mvt).

## Installation
## Getting started

Either run it standalone, or get the source.
1. Install the server `npm i -g geojson-tile-server`

### Standalone
2. Run `geojson-tile-server`

```console
npm i -g geojson-tile-server
```
(By default it serves the './data' folder with the GeoJSON files, and the `./public` folder for static files.)

Optionally, you can specify the PORT (default `8123`), DATA (default `./data`), and PUBLIC_FOLDER (default `./public`) folder in your environment, in which case those values will be used instead.

3. Open http://localhost:8123/ to see which layers are available to you.

### Source
(Final url will be like `http://localhost:8123/your_layer_name/z/x/y.geojson`)

## Contribute / Development

The following commands will download, install & run the source:

```bash
git clone https://github.com/TNOCS/geojson-tile-server.git
Expand All @@ -33,18 +39,6 @@ The source contains a small dataset containing some building contours in Amersfo
- [VT example](http://localhost:8123/Amersfoort.min/15/16876/10800.vt)
- [MVT playground on flems.io](https://flems.io/#0=N4IgzgpgNhDGAuEAmIBcIB0ALeBbKIANCAGYCWMYaA2qAHYCGuEamO+RIsA9nYn6wA8AQgAiAeQDCAFQCaABQCiAAnZQAfAB06gtVrrLluiAyT7Dhwc3gNlsLAwBOkeAF5NIAK7wSAWgAcHsoA9OYWgvBk8DDqAIJISMq28FhkjokADk7wAJ7KAG5w8NyOypEwymDcno6wEILBkdEQYZbWtozM7iD5ZBAA7hkl8EE8fBB83WR0UWQMUL5gsPMQrgCMhLgMAB5kuJ64i8sw64SekI5H8wwARid03EGh2hZGS45kGfCVtd048BkwKhgsEGBkyBhyhAwBgthkbtxthgeLhgnCEdtfABzBYAKzAwXyawwAAZSWiwRjsVAMPiPOoGu9PvBWkYoNMANaqRwQEh-eAAoEgsEQqEw9GI5HcVESzE43z4wnEskkinwxHU5FgMBBHlQbpgXKULAQCAjEAhVmCQ05GIvV7KBFIPLAe0O5RbRxY6aoZQkgDcbodWQS0yxvoDQcMAF8o8oAMRw5Sugzu5RDMCzXi+25VKDeCCB1Pu4oZCNFtOO7gC6XluOGfpkJApX1rEkkgCkFYdseLRmCNrtqYaJtMYUETpyVqQZHyyib3Th9IaM-yVqZX1ZhllOIwDFgdW10m4HImylchgA5LJxABVABKvlikkkigAym-fNJxABpRQAOUvbtXnyJwPTBc9lDoAZwPVbZdwAWTBAAKFNKzGGxpggRxfUvOFL0IetKiNCBcNlYEBxIglZWCdksRwXwiRJAiiIAL24WtlDWAA2Qi+1eOpxhw5RqAAVgwABmABOAAmHjRMIZRRJkjA1lE7ipIAdhkgBdPj3WjABKIs4zhDBeGQy8oG4UwCOUEhPDoBAyAswzkyIszTCQAAZBgcmw5CiMMNDKwsJsyJFKAoCcHIWP4tNcgyUjlCsrC4tCiwqhqOpfRCjLDDFX1qEvf4yxBazjiwbhDVQfw1hkiTgliZhnBIDjHHgWFpmCYBWOjHrtn64AcmjWF8ngS89KCh1EuSy9CgQEp0vy7cdnYziZJk-T8ujbaMsvLLaggXxov8xxL1w+YoGWjLTuqeBcum15Uug3xlgyC6Uscao6CQG78pe47cW4aZPsvb7HL+vbQt2p70wYaYHvc+LK0B3xuCyWAoliiMMF4uGr3ZV6eGs87cK9G5kNEiTFLWTSFK4kkpMM-79qJ47G2bLBPq2uHYZRix+f2-oGEQRwRZyE7bmgS8iOMuMjJM+LPISSReHgb6oGQ6D+lgjFd3-BheixUWXLoNW+E15DDPlvtGVgD5N3tBpJ30Ec8A0bROEgGBnN4Kh0DWfxUE0kBdvoJgWHQWkqGIDCJngVgw8ICPmFYLVY64dWE6T6MdOjIA): You need to insert your own [Mapbox GL access key](https://account.mapbox.com) in order to make this work.

## Usage

To start the development service, run:

```bash
npm start
```

Or if you've installed it globally, run `geojson-tile-server`, which by default serves the './data' folder with the GeoJSON files, and the `./public` folder with static files.

Optionally, you can specify the PORT (default `8123`), DATA (default `./data`), and PUBLIC_FOLDER (default `./public`) folder in your environment, in which case those values will be used instead.

## Note

For another example of a Mapbox-based service, see [here](http://bl.ocks.org/jgravois/51e2b30e3d6cf6c00f06b263a29108a2).