https://github.com/geocodio/lightning-maps

A fast, lightweight slippy map renderer with very minimal dependencies
https://github.com/geocodio/lightning-maps

mapping maps openstreetmap osm slippy-map

Last synced: 3 months ago
JSON representation

A fast, lightweight slippy map renderer with very minimal dependencies

• Host: GitHub
• URL: https://github.com/geocodio/lightning-maps
• Owner: Geocodio
• License: mit
• Archived: true
• Created: 2018-09-26T03:24:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T21:27:31.000Z (over 1 year ago)
• Last Synced: 2024-09-04T20:40:18.677Z (4 months ago)
• Topics: mapping, maps, openstreetmap, osm, slippy-map
• Language: JavaScript
• Homepage: https://geocodio.github.io/lightning-maps/
• Size: 6.82 MB
• Stars: 8
• Watchers: 4
• Forks: 1
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lightning Maps (*Alpha release*)

A fast, lightweight slippy map renderer with very minimal dependencies.

Heavily inspired by [Pigeon Maps](https://github.com/mariusandra/pigeon-maps) and [Leaflet](https://leafletjs.com), but with slightly different goals in mind:

## Goals

* Modern, built using ES6+ syntax

* Lightweight, minimal dependencies

* Ability to render thousands of markers, by using `` rendering instead of depending on the DOM

* Supports rendering of complex polygons

* Wrapper for React (VueJS coming soon)

## Using

### 1. Install

```

yarn add lightning-maps

```

Or link directly to our build via the [unpkg](https://unpkg.com) CDN:

```html

```

### 2. Create a `` element

```html

```

### 3. Instantiate the map and add a marker

```javascript

var map = new LightningMaps.Map(canvas, {

  source: function (x, y, z) {

    return `https://maps.geocod.io/tiles/base/${z}/${x}/${y}.png`;

  },

  zoom: 12,

  center: [38.86530697026126, -77.20057854052735]

});

map.addMarker(new LightningMaps.Marker([38.882666, -77.170150]))

```

### 4. Success! You now have a map

![Example](docs/screenshots/markers.png)

## Development

### Run local development build and tests

```bash

yarn run dev

yarn run test:watch

```

### Development urls:

* [http://localhost:9000/simple.html](http://localhost:9000/simple.html)

* [http://localhost:9000/markers.html](http://localhost:9000/markers.html)

* [http://localhost:9000/polygons.html](http://localhost:9000/polygons.html)

* [http://localhost:9000/events.html](http://localhost:9000/events.html)

* [http://localhost:9000/performance.html](http://localhost:9000/performance.html)

### Build library for distribution

```bash

yarn run build

```