Zum Hauptinhalt springen

Installation

Installation des Backends​

Aktuell kann das Backen nur lokal aus dem Quellcode gebaut werden. In Zukunft wird es eventuell Docker-Images geben.

Voraussetzungen​

Das Projekt benötigt folgende Software:

Installation​

  1. Klonen Sie das Repository mit git clone
git clone https://github.com/paulkoehlerdev/gosmRoutify.git

oder (wenn sie bereits einen ssh-key für GitHub hinterlegt haben)

git clone git@github.com:paulkoehlerdev/gosmRoutify.git
  1. Wechseln Sie in das Verzeichnis des Projektes
cd gosmRoutify
  1. Bauen Sie das Projekt mit make build
make build
  1. Downloaden Sie OSM-Rohdaten (.osm.pbf) von Geofabrik. Die Daten werden im Beispiel in ./resources/data/germany-latest.osm.pbf gespeichert.
wget https://download.geofabrik.de/europe/germany-latest.osm.pbf -O ./resources/data/germany-latest.osm.pbf
  1. Importieren Sie die Daten in die Datenbank mit der loader Binary, die make build erstellt hat.
info

Dieser Schritt kann etwas dauern. Der import von Deutschland dauert ca. 30 Minuten. Für die Entwicklung empfiehlt es sich daher einen kleineren Datensatz zu verwenden. (z. B. Oberbayern, wobei der Import nurnoch ca. 2 Minuten dauert)

./bin/loader -import ./resources/data/germany-latest.osm.pbf -database ./resources/germany.db
  1. Kopieren Sie die Beispiel-Konfiguration in die Konfigurationsdatei. Hier müssen Sie die Datenbank-URL anpassen, wenn Sie einen anderen Datensatz verwenden.
cp ./resources/config.example.json ./resources/config.json
  1. Starten Sie den Server mit der server Binary, die make build erstellt hat.
./bin/router -config ./resources/config.json
  1. Der Server ist nun unter http://localhost:3000 erreichbar. Sie können nun die API verwenden. Der Port und der Bind-Host können in der Konfigurationsdatei angepasst werden.

Installation des Frontends​

Das Frontend ist in TypeScript geschrieben und verwendet Vue.JS 3.

Voraussetzungen​

Das Projekt benötigt folgende Software:

Installation​

  1. Klonen Sie das Repository mit git clone
info

Wenn sie bereits das Backend geklont haben, können Sie diesen Schritt überspringen.

git clone https://github.com/paulkoehlerdev/gosmRoutify.git

oder (wenn sie bereits einen ssh-key für GitHub hinterlegt haben)

git clone git@github.com:paulkoehlerdev/gosmRoutify.git
  1. Wechseln Sie in das Verzeichnis des Projektes
cd gosmRoutify/frontend
  1. Installieren Sie die Abhängigkeiten mit npm install
npm install
  1. Starten Sie den Entwicklungsserver mit npm run dev
npm run dev
  1. Das Frontend ist nun unter http://localhost:5173 erreichbar. Wenn sie den Port oder host des Backends geändert haben, müssen Sie die Datei .env.development anpassen. Die Konfiguration VUE_API_URL muss auf die URL des Backends zeigen.