Skip to content

evan-zhang11/mapflow

 
 

Repository files navigation

MapFlow

CI Release Nightly Security

MapFlow is a lightweight spatial data management app for data curators: upload files, inspect schema, preview tiles, and publish public tile URLs.

License: Apache-2.0

Release Channels

Channel Trigger GitHub Release GHCR Tags Assets
Stable v* tag push Full release latest, vX.Y.Z Linux + macOS bundles
Nightly Daily schedule (02:00 UTC) + manual dispatch Pre-release nightly, nightly-YYYYMMDD, nightly-<sha> Linux + macOS bundles

Each binary bundle contains:

  • mapflow backend executable
  • prebuilt frontend (dist/)
  • spatial-extension-manifest.json

Quickstart (Docker)

Prerequisites: Docker + Docker Compose v2.

Run stable:

docker compose -f docker-compose.ghcr.yml up -d

Run nightly:

MAPFLOW_IMAGE=ghcr.io/sharkandshark/mapflow:nightly docker compose -f docker-compose.ghcr.yml up -d

Stop:

docker compose -f docker-compose.ghcr.yml down

Quickstart (Binary Bundle)

  1. Download an asset from GitHub Releases.
  2. Extract it, then run:
./mapflow

Optional runtime config:

export WEB_DIST=./dist
export DB_PATH=./data/mapflow.duckdb
export UPLOAD_DIR=./uploads
export PORT=3000
./mapflow

Supported Upload Formats

  • Shapefile (.zip with .shp/.shx/.dbf)
  • GeoJSON (.geojson, .json)
  • GeoJSONSeq / NDJSON (.geojsonl, .geojsons)
  • KML (.kml)
  • GPX (.gpx)
  • TopoJSON (.topojson)
  • MBTiles (.mbtiles, vector MVT + raster PNG)

Runtime Configuration

Env Default Description
PORT 3000 HTTP server port
DB_PATH ./data/mapflow.duckdb DuckDB path
UPLOAD_DIR ./uploads Upload storage directory
WEB_DIST frontend/dist Frontend static assets path
UPLOAD_MAX_SIZE_MB 200 Upload max size
COOKIE_SECURE false Set true behind HTTPS
CORS_ALLOWED_ORIGINS http://localhost:3000 Comma-separated CORS allowlist
SPATIAL_EXTENSION_PATH unset Explicit local spatial extension path
SPATIAL_EXTENSION_DIR unset Directory containing spatial.duckdb_extension

Development

just install
just dev

Common commands:

just check
just test
just docker-up-build

Contracts & Internal Docs

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Rust 65.7%
  • JavaScript 25.1%
  • Shell 4.8%
  • CSS 2.6%
  • Just 1.3%
  • Dockerfile 0.4%
  • HTML 0.1%