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

https://github.com/freifunk/cmap.api.freifunk.net

Freifunk Community Map
https://github.com/freifunk/cmap.api.freifunk.net

Last synced: 9 months ago
JSON representation

Freifunk Community Map

Awesome Lists containing this project

README

          

Community Map
=============

## Setup

```
git clone https://github.com/freifunk/cmap.api.freifunk.net.git
cd cmap.api.freifunk.net
yarn install
cp config.json.sample config.json
# maybe edit your config.json
node server.js
```

If you don't see any tiles: Copy `config.json.sample` to `config.json`, add your mapbox id to select your tileset and then start the server.

## Options

Community map accepts options as JSON object

| Name | Standard | Bedeutung |
|--------------------|----------------------------------------------------|----------------------------------------------------------------------|
| ffGeoJsonUrl | "//api.freifunk.net/map/ffGeoJsonp.php?callback=?" | URL with API data, we need jsonp there |
| hideLocationButton | false | |
| hideLayerControl | false | hide or show layer box |
| hideInfoBox | false | hide or show info box |
| feedUrl | "//api.freifunk.net/feed/feed.php" | a feed provided by https://github.com/freifunk/feed.api.freifunk.net |
| newsContentLimit | 3 | number of news entries |
| eventsContentLimit | 2 | number of event entries |
| postContentLength | 30 | length event headlines |
| zoomLevel | 5 | default zoom level on page load |
| center | [51.5,10.5] | initial center of map |
| divid | "map" | div id where map should be displayed |
| showEvents | false | show events in community popup |
| showNews | false | show news in community popup |
| mapboxId | "mapbox.streets" | id for your mapbox tiles |

## Dependencies
(external folder)

* jQuery
* underscore.js
* leaflet.js

## Contribute

The community map is a fun & visual way to know more about open-source communities across Germany. If you think there are cool features that can be integrated in the map, you can let us know by opening an issue, or sending pull requests. Bug reports are equally welcomed.