maputnik

Maputnik

Ein kostenloser und offener visueller Editor für die MapLibre GL-Stile, der sich an Entwickler und Kartendesigner richtet.

Verwendung

• ? Entwerfen Sie Ihre Karten online unter https://www.maplibre.org/maputnik/ (alle im lokalen Speicher)
• ? Verwenden Sie die Maputnik-CLI für die lokale Stilentwicklung
• Führen Sie in einem Docker diesen Befehl aus und navigieren Sie zu http://localhost:8888, Strg+C, um den Server zu stoppen.

docker run -it --rm -p 8888:80 ghcr.io/maplibre/maputnik:main

Dokumentation

Die Dokumentation finden Sie im Wiki. Sie sind herzlich willkommen, mitzuarbeiten!

• ? Studieren Sie das Maputnik-Wiki
• ? Entwerfen Sie eine Karte von Grund auf https://youtu.be/XoDh0gEnBQo

Entwickeln

Maputnik ist in Typoskript geschrieben und verwendet React und MapLibre GL JS.

Wir stellen sicher, dass die Erstellung und Entwicklung von Maputnik mit der aktuell aktiven LTS Node.js-Version und höher funktioniert.

Sehen Sie sich unseren Internationalisierungsleitfaden für Änderungen im Zusammenhang mit UI-Texten an.

Mitmachen

Treten Sie dem Slack-Kanal #maplibre oder #maputnik bei OSMUS bei: Erhalten Sie eine Einladung unter https://slack.openstreetmap.us/. Lesen Sie den folgenden Leitfaden, um sich mit unserer Vorgehensweise hier vertraut zu machen.

Installieren Sie die Deps, starten Sie den Dev-Server und öffnen Sie den Webbrowser unter http://localhost:8888/ .

 # install dependencies
npm install
# start dev server
npm run start

Wenn Sie möchten, dass Maputnik von außen zugänglich ist, verwenden Sie die Option --host :

 # start externally accessible dev server
npm run start -- --host 0.0.0.0

Der Build-Prozess überwacht Änderungen am Dateisystem, erstellt den Editor neu und lädt ihn automatisch neu.

 npm run build

Flusen Sie den JavaScript-Code.

 # run linter
npm run lint
npm run lint-css
npm run sort-styles

Tests

Für E2E-Tests verwenden wir Cypress

Cypress startet keinen Server, daher müssen Sie einen manuell starten, indem Sie npm run start ausführen.

Öffnen Sie nun ein Terminal und führen Sie Folgendes mit Chrome aus:

 npm run test

oder Firefox :

 npm run test -- --browser firefox

Weitere Informationen finden Sie in den folgenden Dokumenten: (Browser starten)[https://docs.cypress.io/guides/guides/launching-browsers]

Sie können die Tests auch während der Ausführung sehen oder auswählen, welche Suiten ausgeführt werden sollen, indem Sie Folgendes ausführen:

 npm run cy:open

Freigabeprozess

1. Überprüfen Sie CHANGELOG.md
   • Überprüfen Sie noch einmal, ob alle in der Version enthaltenen Änderungen ordnungsgemäß dokumentiert sind.
   • Zu veröffentlichende Änderungen sollten unter der Überschrift „main“ stehen.
   • Übernehmen Sie alle endgültigen Änderungen in das Änderungsprotokoll.
2. Führen Sie Bump-Version PR durch manuellen Workflow-Versand erstellen aus und legen Sie die Versionsnummer in der Eingabe fest. Dadurch wird ein PR erstellt, der das Änderungsprotokoll und die Datei package.json ändert, um sie zu überprüfen und zusammenzuführen.
3. Nach der Zusammenführung wird ein automatischer Prozess gestartet, der ein GitHub-Release erstellt und Release-Assets hochlädt.

Sponsoren

Vielen Dank an die Unterstützer der Kickstarter-Kampagne . Ohne diese kommerziellen und individuellen Sponsoren wäre dieses Projekt nicht möglich. Sie können den Verlauf dieser Datei für frühere Sponsoren des ursprünglichen Maputnik-Repos einsehen. Weitere Informationen zum MapLibre-Sponsoring-Programm finden Sie unter https://maplibre.org/sponsors/.

Lizenz

Maputnik ist unter MIT lizenziert und unterliegt dem Copyright (c) Lukas Martinelli und Maplibre-Mitwirkenden. Bitte achten Sie als Mitwirkender besonders darauf, keine Mapbox-Marken zu verletzen. Lassen Sie sich nicht von anderen Kartenstudios inspirieren und treffen Sie Ihre eigene Entscheidung für einen guten Stileditor.