Add frontend

.env.backend.example

@@ -0,0 +1,13 @@
+SUMUP_API_KEY=sup_sk_xxxxx #https://me.sumup.com/settings/developer
+SUMUP_RETURN_URL=https://fqdn.tld/api/payment/v1/callback #make sure this endpoint is reachable!
+JWT_SECRET=changeme #generate a random alphanumeric 64-char string here at least. please.
+
+GIN_TRUSTED_PROXIES=localhost #change this to your reverse proxy ip if applicable
+CORS_ALLOWED_ORIGINS=http://localhost:8080 #all allowed frontend origins, comma separated
+
+DB_HOST=localhost
+POSTGRES_USER=drinks
+POSTGRES_PASSWORD=xxx
+POSTGRES_DATABASE=drinks
+DB_PORT=5432
+DB_TIMEZONE=Europe/Vienna

.env.frontend.example

@@ -0,0 +1,2 @@
+# In production, change this to your actual URL
+NEXT_PUBLIC_API_URL=https://drinks.example.com

.github/workflows/docker-publish-backend.yml

@@ -70,6 +70,7 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
+            type=raw,prefix=backend-,value=latest,enable=${{ github.event_name != 'pull_request' }}
             type=ref,prefix=backend-,event=branch
             type=ref,prefix=backend-,event=tag
             type=ref,prefix=backend-pr-,event=pr

.github/workflows/docker-publish-frontend.yml

@@ -70,6 +70,7 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
+            type=raw,prefix=frontend-,value=latest,enable=${{ github.event_name != 'pull_request' }}
             type=ref,prefix=frontend-,event=branch
             type=ref,prefix=frontend-,event=tag
             type=ref,prefix=frontend-pr-,event=pr

.gitignore

@@ -1,140 +1,2 @@
-.env
-
-### GoLand ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
-# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-
-# User-specific stuff
-.idea/**/workspace.xml
-.idea/**/tasks.xml
-.idea/**/usage.statistics.xml
-.idea/**/dictionaries
-.idea/**/shelf
-
-# AWS User-specific
-.idea/**/aws.xml
-
-# Generated files
-.idea/**/contentModel.xml
-
-# Sensitive or high-churn files
-.idea/**/dataSources/
-.idea/**/dataSources.ids
-.idea/**/dataSources.local.xml
-.idea/**/sqlDataSources.xml
-.idea/**/dynamic.xml
-.idea/**/uiDesigner.xml
-.idea/**/dbnavigator.xml
-
-# Gradle
-.idea/**/gradle.xml
-.idea/**/libraries
-
-# Gradle and Maven with auto-import
-# When using Gradle or Maven with auto-import, you should exclude module files,
-# since they will be recreated, and may cause churn.  Uncomment if using
-# auto-import.
-# .idea/artifacts
-# .idea/compiler.xml
-# .idea/jarRepositories.xml
-# .idea/modules.xml
-# .idea/*.iml
-# .idea/modules
-# *.iml
-# *.ipr
-
-# CMake
-cmake-build-*/
-
-# Mongo Explorer plugin
-.idea/**/mongoSettings.xml
-
-# File-based project format
-*.iws
-
-# IntelliJ
-out/
-
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Cursive Clojure plugin
-.idea/replstate.xml
-
-# SonarLint plugin
-.idea/sonarlint/
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
-com_crashlytics_export_strings.xml
-crashlytics.properties
-crashlytics-build.properties
-fabric.properties
-
-# Editor-based Rest Client
-.idea/httpRequests
-
-# Android studio 3.1+ serialized cache file
-.idea/caches/build_file_checksums.ser
-
-### GoLand Patch ###
-*.iml
-modules.xml
-.idea/misc.xml
-*.ipr
-
-# Sonarlint plugin
-# https://plugins.jetbrains.com/plugin/7973-sonarlint
-.idea/**/sonarlint/
-
-# SonarQube Plugin
-# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
-.idea/**/sonarIssues.xml
-
-# Markdown Navigator plugin
-# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
-.idea/**/markdown-navigator.xml
-.idea/**/markdown-navigator-enh.xml
-.idea/**/markdown-navigator/
-
-# CodeStream plugin
-# https://plugins.jetbrains.com/plugin/12206-codestream
-.idea/codestream.xml
-
-# Azure Toolkit for IntelliJ plugin
-# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
-.idea/**/azureSettings.xml
-
-### macOS ###
-# General
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### macOS Patch ###
-# iCloud generated files
-*.icloud
+.env.*
+!.env.*.example

README.md

@@ -2,53 +2,14 @@
 This project contains the backend and frontend code for the Metadrinks project.
 
 ## Setting up
-Copy the contents of `.env.example` to `.env` and replace the values accordingly.
+Copy `docker-compose.yml`, `.env.backend.example` and `.env.frontend.example` to your project root directory. Replace the values in the example files accordingly and remove the `.example` suffix.
 
-### docker-compose.yml
-
-```
----
-services:
-  postgres:
-    image: postgres:17-alpine
-    container_name: metadrinks-postgres
-    environment:
-      - TZ=Europe/Vienna
-      - POSTGRES_USER=<DB_USER>
-      - POSTGRES_PASSWORD=<DB_PASSWORD>
-      - POSTGRES_DB=<DB_DATABASE>
-    volumes:
-      - ./pg_data:/var/lib/postgresql/data
-    networks:
-      - backend
-    restart: unless-stopped
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U <DB_USER> -d <DB_DATABASE>"]
-      interval: 1s
-      retries: 10
-      start_period: 10s
-      timeout: 30s
-
-  backend:
-    image: ghcr.io/metalab/Metadrinks-backend:main
-    container_name: metadrinks-backend
-    networks:
-      - backend
-    ports:
-      - 8080:8080
-    depends_on:
-      postgres:
-        condition: service_healthy
-        restart: true
-    restart: unless-stopped
-
-networks:
-  backend:
-```
-
-Using this example, your `DB_HOST` would be `metadrinks-postgres`, your `DB_PORT` would be `5432` and everything else would be what you replace the placeholder values with.
+To start, execute `docker compose up -d`. If required or wanted, you can change the ports (in the format `host-port:container-port`, only change the host-port) or the version to ensure no unwanted upgrades happen.
 
 ## Usage
+On first start, a default guest and admin user are generated. The admin password will be printed to your console ONCE (visible by either running `docker compose up` when starting or `docker compose logs` after start).
+
+After the first start, it is recommended to change the admin password via the admin interface under `/admin`. From this page, all management of items, users, readers and purchases takes place.
 
 ### API Docs
-coming soon (when the api is semi-stable and tested)
+Currently, the API docs are served by the backend under /docs/index.html with the file "../swapper.json".

backend/.gitignore

@@ -0,0 +1,142 @@
+.env
+
+### GoLand ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/dataSources.xml
+.idea/**/data_source_mapping.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### GoLand Patch ###
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud