updated readme.md and project descriptions

README.md

@@ -11,38 +11,37 @@
 _Haftungsausschluss: Dieses Repository und die zugehörige Datenbank befinden sich derzeit in einer Beta-Version. Einige Aspekte des Codes und der Daten können noch Fehler enthalten. Bitte kontaktieren Sie uns per E-Mail oder erstellen Sie ein Issue auf GitHub, wenn Sie einen Fehler entdecken._
 
 
+## Hintergrund
+
+Die Idee, Denkmäler und deren Merkmale auf einer digitalen Karte anzuzeigen, ist während eines Spaziergangs durch Flensburg entstanden. Auf dem Open Data Portal Schleswig-Holstein stellt das Landesamt für Denkmalpflege Schleswig-Holstein eine Denkmalliste zur Verfügung, jedoch leider ohne Angabe der Koordinaten. Wir haben uns entschieden, dies zu ändern und einen Prototypen der Öffentlichkeit zugänglich zu machen, indem wir die Einträge mit den Gebäudekoordinaten ergänzen.
+
 
 ## Datenquelle
 
-Die Daten der Kulturdenkmale haben wir über [Landesamt für Denkmalpflege](https://opendata.schleswig-holstein.de/dataset/denkmalliste-flensburg) auf dem Open-Data Portal Schleswig-Holstein bezogen. Es heißt dazu: "Kulturdenkmale sind gesetzlich geschützt und nachrichtlich in ein Verzeichnis, die sog. Denkmalliste, einzutragen. Von der Aufnahme in die Denkmalliste werden die betroffenen Eigentümerinnen und Eigentümer benachrichtigt".
+Das Landesamt für Denkmalpflege Schleswig-Holstein prüft anhand der gesetzlich vorgegebenen Kriterien den besonderen Wert eines Kulturdenkmals und legt die Maßstäbe, die Methodik für die Erfassung und Pflege sowie den Schutzumfang der Kulturdenkmale fest. Die erhobenen Daten der Denkmalliste werden im Open Data Portal des Landes Schleswig-Holstein zum Download angeboten. Die Kartendarstellung wurde von engagierten Einwohner:innen und ehrenamtlichen Mitgliedern des OK Lab Flensburgs entwickelt.
 
 
+## Mitmachen
 
-## Hintergrund
+Du kannst jederzeit ein Issue auf GitHub öffnen oder uns über oklabflensburg@grain.one schreiben
 
-Diese interaktive webbasierte Karte ist auf Basis der Daten des Landesamtes für Denkmalpflege und der Bilddaten des Open Data Repositories der Christian-Albrechts-Universität zu Kiel entstanden. Nach einigen Stunden der Betrachtung der Datensätze konnten wir die Daten lesen und mittels einem selbst geschriebenen Python Skript in ein maschinenlesbares offenes Format nach der Spezifikation [RFC 7946](https://geojson.org/) umwandeln. Wir nutzen die [OpenSteetMap](https://www.openstreetmap.de/) Karte als Basis für die Darstellungen der Marker. Wir mussten die gegebenen Daten bereinigen und Dupliketen aussortieren und die jeweilige Geografische Position mittels der [Google Maps API](https://geopy.readthedocs.io/en/stable/index.html?highlight=GoogleV3#googlev3) in Python aus den vorhandenen Daten wie der Straße und Hausnummer und der Stadt extrahieren. Unser Ziel ist es Interessierten eine Nutzung der offenen Daten mit wenig Arbeit und einem Mehrwert anzubieten.
 
 
 
-## Setup
 
 
-Follow these steps to run on an dev enviroment
 
-```
-sudo apt install git git-lfs virtualenv python3 python3-pip postgresql-15 postgresql-15-postgis-3 postgis
-```
 
+## Prerequisite
 
-Clone repository `open-monuments-map` and move in
+Install system dependencies and clone repository
 
 ```
+sudo apt install git git-lfs virtualenv python3 python3-pip postgresql-16 postgresql-16-postgis-3
 git clone https://github.com/oklabflensburg/open-monuments-map.git
-cd open-monuments-map
 ```
 
-
-Create dot `.env` file and add the following vars with `vim .env`
+Create a dot `.env` file inside the project root. Make sure to add the following content and repace values.
 
 ```
 DB_PASS=postgres
@@ -53,23 +52,25 @@ DB_PORT=5432
 ```
 
 
-If you want to update the repository use these commands
+## Update repository
 
 ```
 git pull
 git lfs pull
-git lfs install
 ```
 
-Finally you can run sql statements inside `open-monuments-map` directory
+
+## Create SQL schema
+
+Run sql statements inside `open-monuments-map` root directory
 
 ```
 sudo -i -Hu postgres psql -U postgres -h localhost -d postgres -p 5432 < data/denkmalliste_schema.sql
 sudo -i -Hu postgres psql -U postgres -h localhost -d postgres -p 5432 < data/denkmalliste_geometrien_schema.sql
 ```
 
 
-Next we add all administrative geometries to our database
+Next add administrative geometries
 
 ```
 ogr2ogr -f "PostgreSQL" PG:"dbname=postgres user=postgres port=5432 host=localhost" "data/vg250gem.geojson" -nln vg250gem

src/index.html

@@ -28,7 +28,7 @@ <h2><a href="/" class="text-xl md:text-2xl text-gray-700 hover:text-blue-700 foc
                 </div>
                 <div class="mt-3 md:mt-6 py-2 px-3" id="about">
                     <h3 class="font-bold text-xl md:text-2xl mb-1">Hintergrund</h3>
-                    <p class="font-normal leading-normal text-md lg:text-lg mb-3 md:mb-6">Die Idee ist während eines Spaziergangs durch die Flensburg entstanden. Auf dem Open Data Portal Schleswig-Holstein, stellt das Landesamt für Denkmalpflege Schleswig-Holstein eine Denkmalliste zur Verfügung, jedoch leider ohne Angabe der Koordinaten. Wir haben uns entschieden, dies zu ändern und einen Prototypen der Öffentlichkeit zugänglich zu machen. Wir ergänzen die Einträge mit den Gebäudekoordinaten. Falls Sie Anregungen, Kritik oder Ergänzungen haben, schreiben Sie uns bitte eine <a class="text-blue-600 hover:text-blue-400 focus:text-blue-400" href="mailto:oklabflensburg@grain.one" target="_blank">E-Mail</a>.</p>
+                    <p class="font-normal leading-normal text-md lg:text-lg mb-3 md:mb-6">Die Idee, Denkmäler und deren Merkmale auf einer digitalen Karte anzuzeigen, ist während eines Spaziergangs durch Flensburg entstanden. Auf dem Open Data Portal Schleswig-Holstein stellt das Landesamt für Denkmalpflege Schleswig-Holstein eine Denkmalliste zur Verfügung, jedoch leider ohne Angabe der Koordinaten. Wir haben uns entschieden, dies zu ändern und einen Prototypen der Öffentlichkeit zugänglich zu machen, indem wir die Einträge mit den Gebäudekoordinaten ergänzen. Falls Sie Anregungen, Kritik oder Ergänzungen haben, schreiben Sie uns bitte eine <a class="text-blue-600 hover:text-blue-400 focus:text-blue-400" href="mailto:oklabflensburg@grain.one" target="_blank">E-Mail</a>.</p>
                     <h3 class="font-bold text-xl md:text-2xl mb-1">Datenquelle</h3>
                     <p class="font-normal leading-normal text-md lg:text-lg mb-3 md:mb-6">Das Landesamt für Denkmalpflege Schleswig-Holstein prüft anhand der gesetzlich vorgegebenen Kriterien den besonderen Wert eines Kulturdenkmals und legt die Maßstäbe, die Methodik für die Erfassung und Pflege sowie den Schutzumfang der Kulturdenkmale fest. Die erhobenen Daten der Denkmalliste werden im Open Data Portal des Landes Schleswig-Holstein <a class="text-blue-600 hover:text-blue-400 focus:text-blue-400" href="https://opendata.schleswig-holstein.de/organization/landesamt-fur-denkmalpflege" target="_blank">zum Download</a> angeboten. Die Kartendarstellung wurde von engagierten Einwohner:innen und ehrenamtlichen Mitgliedern des OK Lab Flensburgs entwickelt.</p> 
                    <h3 class="font-bold text-xl md:text-2xl mb-1">Quellcode</h3>