Skip to content

Commit

Permalink
updated readme with missing setup details
Browse files Browse the repository at this point in the history
  • Loading branch information
p3t3r67x0 committed Sep 25, 2024
1 parent db1603d commit 8434762
Show file tree
Hide file tree
Showing 6 changed files with 368 additions and 239 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
dist/
venv/
.parcel-cache/
node_modules/
coverage/
venv/
dist/
__MACOSX/
.DS_Store
.env
.idea
*.zip
*.tgz
*.suo
*.local
Expand Down
73 changes: 72 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kulturnacht Flensburg
# Kalturkarte Flensburg Kulturnacht

[![Lint css files](https://github.com/oklabflensburg/open-cultural-map/actions/workflows/lint-css.yml/badge.svg)](https://github.com/oklabflensburg/open-cultural-map/actions/workflows/lint-css.yml)
[![Lint html files](https://github.com/oklabflensburg/open-cultural-map/actions/workflows/lint-html.yml/badge.svg)](https://github.com/oklabflensburg/open-cultural-map/actions/workflows/lint-html.yml)
Expand All @@ -7,6 +7,54 @@

![Screenshot Kulturnacht Flensburg](https://raw.githubusercontent.com/oklabflensburg/open-cultural-map/main/screenshot_kulturkarte.webp)

_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 Kulturakteure präsentieren sich an unterschiedlichsten Orten in der Stadt, um diese Orte sichtbar zu machen haben wir vom OK Lab Flensburg eigens dafür eine Kulturnachtkarte entwickelt. Am 14. September 2024 haben Flensburger Kulturakteure zur Kulturnacht Flensburg eingeladen. Es haben viele Orte und Richtungen des kulturellen Wirkens in Flensburg in dieser Nacht ihre Türen geöffnent und in ihrer Einzigartigkeit und Gesamtheit präsentiert. Von Theaterstücken, einem Blick hinter die Kulissen, Konzerten, kreativen Mit-Mach-Aktionen oder gemeinsamen Gesprächen und Miteinander.


## Mitmachen

Du kannst jederzeit ein Issue auf GitHub öffnen oder uns über oklabflensburg@grain.one schreiben


## Prerequisite

Install system dependencies and clone repository

```
sudo apt install wget curl
sudo apt install git git-lfs
sudo apt install python3 python3-pip python3-venv
sudo apt install gnupg2 gdal-bin osm2pgsql
wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor > postgresql-keyring.gpg
sudo mv postgresql-keyring.gpg /etc/apt/trusted.gpg.d/
sudo chown root:root /etc/apt/trusted.gpg.d/postgresql-keyring.gpg
sudo chmod ugo+r /etc/apt/trusted.gpg.d/postgresql-keyring.gpg
sudo chmod go-w /etc/apt/trusted.gpg.d/postgresql-keyring.gpg
echo "deb [arch=amd64, signed-by=/etc/apt/trusted.gpg.d/postgresql-keyring.gpg] http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
sudo apt update
sudo apt install postgresql-16 postgresql-16-postgis-3 postgresql-client-16
# install NVM (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
# download and install Node.js
nvm install 20
# verifies the right Node.js version is in the environment
node -v
# verifies the right NPM version is in the environment
npm -v
git clone https://github.com/oklabflensburg/open-monuments-map.git
```


Create a dot `.env` file inside the project root. Make sure to add the following content and repace values.

Expand All @@ -32,6 +80,29 @@ DB_PORT=5432
```


## Update repository

```
git pull
git lfs pull
```


## Update dataset

Next initialize python virtualenv and install the dependencies

```
cd tools
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
python3 generate_geojson.py ../data/kulturnacht-flensburg-2024.csv
python3 generate_sitemap.py ../data/kulturnacht-flensburg-2024.geojson ../static/sitemap.xml https://knf.grain.one/
deactivate
```


## LICENSE

[CC0-1.0](LICENSE)
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@
},
"dependencies": {
"@eslint/eslintrc": "^3.1.0",
"@eslint/js": "^9.10.0",
"@eslint/js": "^9.11.1",
"globals": "^15.9.0",
"leaflet": "^1.9.4",
"parcel": "^2.12.0"
},
"devDependencies": {
"@parcel/config-default": "^2.12.0",
"@parcel/transformer-raw": "^2.12.0",
"eslint": "^9.10.0",
"eslint": "^9.11.1",
"htmlhint": "^1.1.4",
"leaflet-control-geocoder": "^2.4.0",
"leaflet.markercluster": "^1.5.3",
"parcel-reporter-static-files-copy": "^1.5.3",
"postcss": "^8.4.45",
"postcss": "^8.4.47",
"stylelint": "^16.9.0",
"stylelint-config-standard": "^36.0.1",
"tailwindcss": "^3.4.11"
"tailwindcss": "^3.4.13"
},
"pnpm": {
"peerDependencyRules": {
Expand Down
Loading

0 comments on commit 8434762

Please sign in to comment.