Files
maptool/README.adoc
T
randy 5afb130c45 Switch to vector maps (MapLibre GL JS + PMTiles) and add RainViewer radar
Replace Leaflet/raster tiles with MapLibre GL JS: an online OpenFreeMap
style and an offline style built from a local PMTiles archive via
pmtiles.js and protomaps-themes-base (no glyphs/labels offline by
design, see docs/architecture.adoc). Frontend libraries are vendored
locally rather than loaded from a CDN so the app keeps working with no
internet access.

Also add an animated RainViewer precipitation radar overlay (toggle,
play/pause, scrub slider), matching the default time window of the
weather-radar-card Home Assistant integration.
2026-08-25 01:18:36 +02:00

39 lines
948 B
Plaintext

= MapTool
:toc:
:toclevels: 2
:source-highlighter: rouge
A mapping application backend written in Ruby with Sinatra, optionally
wrapped as a native desktop app with Tauri.
The project's shape is still open — this is the initial scaffold.
== Status
Early scaffold. The web application serves a vector map (MapLibre GL
JS), with an online style and an optional offline style backed by a
local PMTiles file; the desktop shell boots the same server inside a
native window.
== Requirements
* Ruby (see `.ruby-version`) and Bundler
* Rust and the Tauri CLI, only if you want to build the desktop shell
(see `docs/development.adoc`)
== Getting started
[source,shell]
----
bundle install
bundle exec puma -C config/puma.rb
----
Then open http://127.0.0.1:4567 in a browser.
== Documentation
* link:docs/architecture.adoc[Architecture]
* link:docs/development.adoc[Development guide]
* link:docs/third-party-notices.adoc[Third-party notices]