Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urbica/tessella

Lightweight Node.js Mapbox Vector Tiles server
https://github.com/urbica/tessella

docker map mapbox-vector-tiles mbtiles nodejs

Last synced: about 2 months ago
JSON representation

Lightweight Node.js Mapbox Vector Tiles server

Awesome Lists containing this project

README

        

# tessella

[![npm version](https://img.shields.io/npm/v/tessella.svg)](https://www.npmjs.com/package/tessella)
[![npm downloads](https://img.shields.io/npm/dt/tessella.svg)](https://www.npmjs.com/package/tessella)
[![build status](https://travis-ci.org/urbica/tessella.svg?branch=master)](https://travis-ci.org/urbica/tessella)
![docker pulls](https://img.shields.io/docker/pulls/urbica/tessella.svg)

tessella is a lightweight Node.js [Mapbox Vector Tiles](https://github.com/mapbox/vector-tile-spec) server.
Inspired by [tessera](https://github.com/mojodna/tessera).

## Installation

tessella requires node v7.6.0 or higher for ES2015 and async function support.

```shell
npm install tessella -g
npm install -g
```

...or build from source

```shell
git clone https://github.com/urbica/tessella.git
cd tessella
npm i
```

## Usage

```shell
Usage: tessella [options] [URI]

where [uri] is tilelive URI to serve and [options] is any of:
--port - port to run on (default: 4000)
--socket - use Unix socket instead of port
--cacheSize - cache size in MB (default: 10)
--sourceCacheSize - source cache size in # of sources (default: 6)
--version - returns running version then exits
```

### Examples

MBTiles

```shell
npm install -g @mapbox/mbtiles
tessella mbtiles://./whatever.mbtiles
```

PostGIS

```shell
npm install -g tilelive-postgis
tessella postgis://localhost/test?table=tableName&geometry_field=geom
```

## Using with Leaflet

```js
const map = L.map("map").setView([0, 0], 0);
L.tileLayer("http://localhost:4000/{z}/{x}/{y}.png").addTo(map);
```

with retina support:

```js
const map = L.map("map").setView([0, 0], 0);
L.tileLayer("http://localhost:4000/{z}/{x}/{y}{r}.png").addTo(map, {
detectRetina: true
});
```

## Using with Docker

```shell
docker run -d -p 4000:4000
```

Where `URI` is is tilelive URI to serve.