A modest, but cozy home for your map tiles
HTML JavaScript
Switch branches/tags
Nothing to show
Clone or download

README.md

tile hut cover

Tilehut.js

A modest, but cozy home for your map tiles

Tilehut.js is a project by:

Introduction

Take all the best things about the interactivity of the web and couple it with the exploratory nature of maps, and you get the modern web map tile. Tiles are one of the fundamental building blocks of modern web maps, providing a clever solution to zoom, pan, click, and interact with the infinity of discoverable things living in geospace. Underlying map tiles is a tasty combination of awesome technologies like Mike Migurski's Tilestache and the brilliant tools being built by Mapbox.

Drawing from these inspiring developments in the web mapping world, we bring you Tilehut.js, a modest, but cozy home for your map tiles. Tilehut.js is built to serve the tiles for your average web mapping project and is essentially a simple wrapper around Mapbox's node-mbtiles. Tilehut.js is indeed a humble tile server and is certainly not a replacement for the all excellent support that comes with Mapbox hosting for those more demanding or bigger projects.

We're thrilled to bring you Tilehut.js and even more excited to see what projects you brew up! Happy mapping!

Your Own Hosted Tileserver

You can install Tilehut.js on your local machine or to any other server which supports node.js. This means we have a number of options - e.g. platforms as services (PaaS) - for deploying our tiles to the web.

We've tested a few services and have documented our methods as part of other tutorials. You're welcome to decide which service best fits your needs. So far we've tried/tested deployment to:

After deploying to your chosen platform, you can inspect your data via:

Now you can inspect your map ...

{yourURL}.com/{tilesetname}/map

... and the tiles are ready to use via

{yourURL}.com/{tilesetname}/{z}/{x}/{y}.png (for raster tiles) or {yourURL}.com/{tilesetname}/{z}/{x}/{y}.pbf (for vector tiles)

Tutorial: Getting Started with Tiles

We prepared quite a comprehensive tutorial which covers everything step-by-step. Starting from creating a tileset, to setting up OpenShift and finally using your own tileset.

Examples

See the examples folder for how to use the tilset (raster, utf-8 grid and vector tiles) in your own projects.

API

Inspector

Visit server/{tilesetname}/map to inspect a tileset. This works for raster, utf-8 and vector tiles.

ZXY

The tiles are served via server/{tileset-name}/{z}/{x}/{y}.{extension} e.g.:

  • bitmap e.g. server/tiles-world-simple/4/7/7.png
  • vector e.g. server/tiles-world-vector/5/17/10.pbf
  • utf-8 grid e.g. server/tiles-world-utfgrid/4/10/6.grid.json

Meta Information

Get the meta informations e.g. lat/lon bounds, min and max zoom level etc. via server/{tileset-name}/meta.json

Ping (is my server running?)

Check whether you server works by calling server/ping. Server should respond: "tilehut says pong!"

Development

$ npm run watch

Acknowledgments