facilmap/README.md

FacilMap is an online map that aims to bring together many useful functions in a usable and pretty way onto an open-source map based on OpenStreetMap. Features include:

• Different map styles: OpenMapSurfer, Mapnik, OpenCycleMap, Hike & Bike map.
• Public Transportation and hillshading overlays.
• Search and calculate routes. Routes are fully draggable. (Uses Nominatim, OSRM, OpenRouteService, Leaflet.DraggableLines.)
• Show GPX/KML/OSM/GeoJSON files on the map (use Tools → Import File, type a URL into the search field, or simply drag and drop a file onto the map)
• Show additional information about places (for example opening hours or a link to the website). Press the map for 1 second somewhere to show information about what is there. (Uses Nominatim.)
• Zoom to the location of your device and follow it. (Uses leaflet-locatecontrol.)
• Create a collaborative map under a custom link where you and others can add markers, draw lines, save routes and import GPX/KML/OSM/GeoJSON files
  • Every map has three links, a read-only link, an editable link and an admin link. Everyone who has the link can access the map (similar to Etherpad, just for maps).
  • Live collaboration. All changes to the map are immediately visible to everyone who is looking at it (using socket.io).
  • Markers and lines can have a name and description, which will be visible in a popup when clicking on it.
  • Custom types of markers and lines can be defined, where in addition to the name and description, more text fields, dropdowns and checkboxes can be added to be filled out. Custom dropdown fields can modify the style (colour and width) of the markers and lines automatically, and a legend is generated automatically to explain what the different styles stand for.
  • The current map view can be saved for others to open.
  • Map objects that do not fit a certain filter expression can be hidden (using Filtrex).
  • There is a modification history and changes can be undone.
• Can be easily run on your server or embedded into your website (see below).

On the client side, FacilMap relies heavily on Vue.js, Leaflet and Bootstrap. On the server side, it uses Node.js, Sequelize and socket.io. FacilMap is written in TypeScript.

Developer documentation

• Embed FacilMap into your website
• Run the FacilMap server yourself
• Use the FacilMap client to receive changes and add/update/remove objects to/from a FacilMap programmatically from a JavaScript web or server application.

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 under Run the FacilMap server yourself.