facilmap/README.md

[FacilMap](https://facilmap.org/) is a privacy-friendly, open-source versatile online map that combines different services based on OpenStreetMap and makes it easy to find places, plan routes and create custom maps full of markers, lines and routes. Features include:

* Different map styles for roads, topography, cycling, hiking, public transportation, water navigation, ...
* Search for places and show their information (website, opening hours, ...)
* Calculate routes and adjust them by dragging. An elevation profile can be shown.
* Smartphone-friendly interface.
* Create and share custom maps with markers, lines and routes on them.
* Open GPX/KML/OSM/GeoJSON files and save them on a custom map.
* Define custom styles of markers, lines and routes and generate a legend automatically.
* Define custom form fields for the details of markers, lines and routes.
* API to embed custom maps into a website and to modify them programmatically.
* Extensive [documentation](https://docs.facilmap.org/).

Documentation
=============

For more information, have a look at the [documentation](https://docs.facilmap.org/).

Quick links:
* [User guide](https://docs.facilmap.org/users/)
* [Embed FacilMap into a website](https://docs.facilmap.org/developers/embed.html)
* [Run the FacilMap server](https://docs.facilmap.org/developers/server/)
* [Use the FacilMap client](https://docs.facilmap.org/developers/client/) to programmatically modify objects on a collaborative map.
* [Dev setup](https://docs.facilmap.org/developers/development/dev-setup.html)


Quick start
===========

1. Run `yarn install` to install the dependencies
2. Run `yarn build` to build the JS bundles
3. Copy `config.env.example` to `config.env` and adjust the settings
4. Run `yarn server` inside the `server` directory

More details can be found in the [Administrator guide](https://docs.facilmap.org/administrators/server.html#standalone) and the [Developer guide](https://docs.facilmap.org/developers/development/dev-setup.html).


Support FacilMap
================

[Financial support](https://docs.facilmap.org/users/contribute/) is always welcome!