A fully-featured OpenStreetMap-based map where markers and lines can be added with live collaboration.
 
 
 
 
 
 
Go to file
Candid Dauth d89ac153b4 WIP 2024-05-20 13:19:39 +02:00
.github Merge branch 'vue3' 2024-03-29 01:57:19 +01:00
.yarn Upgrade facilmap-client-v3 dependency 2024-04-21 05:03:30 +02:00
artwork
client WIP 2024-05-20 13:19:39 +02:00
docs WIP 2024-05-20 13:19:39 +02:00
frontend WIP 2024-05-20 13:19:39 +02:00
integration-tests First attempt to implement a REST API 2024-05-20 13:19:39 +02:00
leaflet WIP 2024-05-20 13:19:39 +02:00
server WIP 2024-05-20 13:19:39 +02:00
types WIP 2024-05-20 13:19:39 +02:00
utils WIP 2024-05-20 13:19:39 +02:00
.dockerignore
.eslintrc.cjs Upgrade dependencies 2024-04-09 21:12:34 +02:00
.gitignore gitignore temporary vite config files 2024-04-03 21:06:18 +02:00
.htmlhintrc
.yarnrc.yml
Dockerfile
LICENSE.md
README.md Add heading to README 2024-04-05 00:14:34 +02:00
config.env.example Use Open Elevation instead of MapZen to retrieve point elevation (#250) 2024-03-16 06:54:42 +01:00
docker-compose.yml
package.json Upgrade dependencies 2024-04-09 21:12:34 +02:00
tsconfig.base.json Use JSON i18n files for compatibility with weblate 2024-04-04 22:42:25 +02:00
tsconfig.json
yarn.lock Add REST client, stream JSON, add type safety to REST backend 2024-05-20 13:19:39 +02:00

README.md

FacilMap

FacilMap is a privacy-friendly, open-source versatile online map that combines different services based on OpenStreetMap and makes it easy to find places, plan trips and add markers, lines and routes to custom maps with live collaboration. Features include:

  • Choose between 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, optionally with an elevation profile and details about road quality
  • Show POIs on the map (amenities, attractions, businesses, …)
  • Smartphone-friendly interface and Progressive Web App
  • Create collaborative maps, add markers, lines and routes and collaborate live through a share link
  • View GPX/KML/OSM/GeoJSON files or import them to a collaborative map
  • Export collaborative maps to GPX or GeoJSON to import them into OsmAnd or other apps
  • Link or embed a read-only or editable version of a collaborative map on your website
  • Define different types of markers/lines with custom form fields to be filled out
  • Create custom views where markers/lines are shown/hidden based on their form field values
  • Define custom styles of markers/lines and routes and generate a legend automatically
  • Export the field values of markers/lines as HTML or CSV to import them into a spreadsheet
  • Programmatically read and modify collaborative maps through a Socket.io API
  • Extensive user and developer documentation.

Documentation

For more information, have a look at the documentation.

Quick links:

Get help

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 and the Developer guide.

Contribute

  • Raise bugs, feature requests and ideas as issues
  • Help translate FacilMap into different languages on Weblate
  • Create a local dev setup and open pull requests
  • Donate
  • Spread the word!

Support FacilMap

I have been working on FacilMap as a hobby since 2009. While I have plenty of ideas and motivation to develop the app further, I have only limited time and resources to do so. By financially supporting FacilMap, you allow me to spend more time implementing new features and to afford the infrastructure that is necessary to keep the app running for a growing number of users. Also, feel free to request the features that you would like to see!