Compare commits
No commits in common. "16bf581c603b0deb8273d9b47a5b9d266f307f21" and "e22fb71daa3f2943e18e37563a84a722f5180e6d" have entirely different histories.
16bf581c60
...
e22fb71daa
@ -21,38 +21,5 @@ layout: hextra-home
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="hx-mb-6">
|
<div class="hx-mb-6">
|
||||||
{{< hextra/hero-button text="Schnellstart für Nutzer 👉" link="./user" >}}
|
{{< hextra/hero-button text="Schnellstart für Nutzer 👉" link="user" >}}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{{< hextra/feature-grid >}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Anwenderdoku"
|
|
||||||
subtitle="Orgs, Teams und Läufer:innen anlegen, verwalten und mehr."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(194,97,254,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./user"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Admindoku"
|
|
||||||
subtitle="Installation, Konfiguration und Bedienung des Läufersystems."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(142,53,74,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./admin"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Selfservice"
|
|
||||||
subtitle="Portal für Bürger- und Firmenläufer:innen."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(221,210,59,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./selfservice"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Scannerstationen"
|
|
||||||
subtitle="Karten scannen, Kilometer und erfassen. Bedienung, Hardware und Software."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(59,221,210,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./scanstation"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Beamershow"
|
|
||||||
subtitle="Aktuelle Statistiken und Toplisten zum Event."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(97,254,97,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./beamershow"
|
|
||||||
>}}
|
|
||||||
{{< /hextra/feature-grid >}}
|
|
@ -10,49 +10,16 @@ layout: hextra-home
|
|||||||
|
|
||||||
<div class="hx-mt-6 hx-mb-6">
|
<div class="hx-mt-6 hx-mb-6">
|
||||||
{{< hextra/hero-headline >}}
|
{{< hextra/hero-headline >}}
|
||||||
Documentation of the LfK! Runner System.
|
Documentation of the LfK! Runner System.
|
||||||
{{< /hextra/hero-headline >}}
|
{{< /hextra/hero-headline >}}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="hx-mb-12">
|
<div class="hx-mb-12">
|
||||||
{{< hextra/hero-subtitle >}}
|
{{< hextra/hero-subtitle >}}
|
||||||
Here you will find all the information you need to install, configure, and use the LfK! Runner System.
|
Here you will find all the information you need to install, configure, and use the LfK! Runner System.
|
||||||
{{< /hextra/hero-subtitle >}}
|
{{< /hextra/hero-subtitle >}}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="hx-mb-6">
|
<div class="hx-mb-6">
|
||||||
{{< hextra/hero-button text="Quickstart for Users 👉" link="./user" >}}
|
{{< hextra/hero-button text="Quickstart for Users 👉" link="user" >}}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{{< hextra/feature-grid >}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="User Documentation"
|
|
||||||
subtitle="Create and manage orgs, teams, runners and mire."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(194,97,254,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./user"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Admin Documentation"
|
|
||||||
subtitle="Installation, configuration, and operation of the runner system."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(142,53,74,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./admin"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Self-service"
|
|
||||||
subtitle="Portal for citizen and company runners."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(221,210,59,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./selfservice"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Scanner Stations"
|
|
||||||
subtitle="Scan cards, record kilometers. How-to, hardware, and software."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(59,221,210,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./scanstation"
|
|
||||||
>}}
|
|
||||||
{{< hextra/feature-card
|
|
||||||
title="Beamer Show"
|
|
||||||
subtitle="Current statistics and top lists for the event."
|
|
||||||
style="background: radial-gradient(ellipse at 50% 80%,rgba(97,254,97,0.15),hsla(0,0%,100%,0));"
|
|
||||||
link="./beamershow"
|
|
||||||
>}}
|
|
||||||
{{< /hextra/feature-grid >}}
|
|
@ -9,7 +9,7 @@ cascade:
|
|||||||
---
|
---
|
||||||
|
|
||||||
Dieser Teil der Dokumentation befasst sich mit der Installation, Konfiguration und Bedienung des Läufersystems für normale Admins.
|
Dieser Teil der Dokumentation befasst sich mit der Installation, Konfiguration und Bedienung des Läufersystems für normale Admins.
|
||||||
Solltest du an der Bedienung für normale Nutzer interessiert sein schau doch mal in den [Nutzerbereich](../../user).
|
Solltest du an der Bedienung für normale Nutzer interessiert sein schau doch mal in den [Nutzerbereich](/user).
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
|
@ -9,7 +9,7 @@ cascade:
|
|||||||
---
|
---
|
||||||
|
|
||||||
This part of the documentation deals with the installation, configuration, and operation of the runner system for regular admins.
|
This part of the documentation deals with the installation, configuration, and operation of the runner system for regular admins.
|
||||||
If you are interested in the operation for regular users, take a look at the [User Area](../../user).
|
If you are interested in the operation for regular users, take a look at the [User Area](/user).
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ Hier musst du die URL deines LfK-Backends eintragen (z.B.: `https://lauf-fuer-ka
|
|||||||
### Client-Token
|
### Client-Token
|
||||||
|
|
||||||
Als nächstes musst du noch einen Client Token gefragt.
|
Als nächstes musst du noch einen Client Token gefragt.
|
||||||
Die Anlage ist unter [Token anlegen](../../user/scanstations) beschrieben.
|
Die Anlage ist unter [Token anlegen](/user/scanstation) beschrieben.
|
||||||
|
|
||||||
### Bestätigen
|
### Bestätigen
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ Here you need to enter the URL of your LfK backend (e.g., `https://lauf-fuer-kay
|
|||||||
### Client Token
|
### Client Token
|
||||||
|
|
||||||
Next, you will be asked for a Client Token.
|
Next, you will be asked for a Client Token.
|
||||||
The setup is described under [Create Token](../../user/scanstations).
|
The setup is described under [Create Token](/user/scanstation).
|
||||||
|
|
||||||
### Confirm
|
### Confirm
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ cascade:
|
|||||||
type: docs
|
type: docs
|
||||||
---
|
---
|
||||||
Dieser Teil der Dokumentation befasst sich mit der Bedienung des Läufersystems für normale Nutzer:innen.
|
Dieser Teil der Dokumentation befasst sich mit der Bedienung des Läufersystems für normale Nutzer:innen.
|
||||||
Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den [Admin](../admin) Bereich.
|
Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den [Admin](/admins) Bereich.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
|
@ -6,7 +6,7 @@ cascade:
|
|||||||
---
|
---
|
||||||
|
|
||||||
This part of the documentation describes the interaction with the system for normal users.
|
This part of the documentation describes the interaction with the system for normal users.
|
||||||
If you're interested in installing, configuring or administrating the system take a look at the [admin section](../admin).
|
If you're interested in installing, configuring or administrating the system take a look at the [admin section](/admin).
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@ weight: 3
|
|||||||
---
|
---
|
||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu [hier](../../selfservice/orgs).
|
Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu [hier](/selfservice/orgs).
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer.
|
Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer.
|
||||||
|
@ -4,7 +4,7 @@ weight: 3
|
|||||||
---
|
---
|
||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
If you are interested in the self-service for organizations, you can find the documentation [here](../../selfservice/orgs).
|
If you are interested in the self-service for organizations, you can find the documentation [here](/selfservice/orgs).
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
Runner organizations are the heart of the group system for runners.
|
Runner organizations are the heart of the group system for runners.
|
||||||
|
@ -4,7 +4,7 @@ weight: 13
|
|||||||
---
|
---
|
||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
Die Doku zur Nutzung der [Scannerstationen gibt es hier](../../scanstation)
|
Die Doku zur Nutzung der [Scannerstationen gibt es hier](/scanstation)
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
Scannerstationen sind erstellen Scans für Läuferkarten auf [Tracks](../tracks).
|
Scannerstationen sind erstellen Scans für Läuferkarten auf [Tracks](../tracks).
|
||||||
|
@ -4,7 +4,7 @@ weight: 13
|
|||||||
---
|
---
|
||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
The documentation for using the [scanner stations can be found here](../../scanstation)
|
The documentation for using the [scanner stations can be found here](/scanstation)
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
Scanner stations create scans for runner cards on [Tracks](../tracks).
|
Scanner stations create scans for runner cards on [Tracks](../tracks).
|
||||||
|
@ -5,7 +5,7 @@ weight: 2
|
|||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
Administratoren können Nutzer:innen im System anlegen und verwalten.
|
Administratoren können Nutzer:innen im System anlegen und verwalten.
|
||||||
Mehr Informationen dazu findest du im [Admin](../../admin) Bereich.
|
Mehr Informationen dazu findest du im [Admin](/admin) Bereich.
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
## Passwort vergessen
|
## Passwort vergessen
|
||||||
|
@ -5,7 +5,7 @@ weight: 2
|
|||||||
|
|
||||||
{{< callout type="info" >}}
|
{{< callout type="info" >}}
|
||||||
Administrators can create and manage users in the system.
|
Administrators can create and manage users in the system.
|
||||||
You can find more information in the [Admin](../../admin) section.
|
You can find more information in the [Admin](/admin) section.
|
||||||
{{< /callout >}}
|
{{< /callout >}}
|
||||||
|
|
||||||
## Forgot Password
|
## Forgot Password
|
||||||
|
@ -1,6 +1,4 @@
|
|||||||
<p style="text-align: center !important;">
|
<div style="text-align: center; width: 100%;"></div>
|
||||||
Made by <a href="https://odit.services/?ref=lfk-docs" target="_blank" rel="noreferrer" style="color:magenta !important; font-weight: bold;">ODIT.Services</a> with ❤️
|
Made by <a href="https://odit.services/?ref=lfk-docs" target="_blank" rel="noreferrer">ODIT.Services</a> with ❤️ <br>
|
||||||
and <a href="https://gohugo.io/" rel="noreferrer" target="_blank" style="color: rgb(63, 198, 250); font-weight: bold;">Hugo</a> -
|
Developed for <a href="https://lauf-fuer-kaya.de" target="_blank" rel="noreferrer">Lauf für Kaya</a> | <a href="https://lauf-fuer-kaya.de/impressum" target="_blank" rel="noreferrer">Imprint</a> | <a href="https://lauf-fuer-kaya.de/datenschutz" target="_blank" rel="noreferrer">Privacy</a>
|
||||||
Developed for the <a href="https://lauf-fuer-kaya.de" target="_blank" rel="noreferrer" style="color: #ebb951; font-weight: bold;">Lauf für Kaya! charity run</a> <br>
|
</div>
|
||||||
<a href="https://lauf-fuer-kaya.de/impressum" target="_blank" rel="noreferrer">Imprint</a> | <a href="https://lauf-fuer-kaya.de/datenschutz" target="_blank" rel="noreferrer">Privacy</a>
|
|
||||||
</p>
|
|
33
legacy/.argo/application.yaml
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
apiVersion: argoproj.io/v1alpha1
|
||||||
|
kind: Application
|
||||||
|
metadata:
|
||||||
|
annotations:
|
||||||
|
argocd-image-updater.argoproj.io/image-list: docs=registry.odit.services/lfk/docs:latest
|
||||||
|
argocd-image-updater.argoproj.io/write-back-method: argocd
|
||||||
|
argocd-image-updater.argoproj.io/update-strategy: digest
|
||||||
|
argocd-image-updater.argoproj.io/docs.pull-secret: pullsecret:argocd/registry-odit-services
|
||||||
|
name: docs-lfk-de
|
||||||
|
namespace: argocd
|
||||||
|
spec:
|
||||||
|
project: lfk
|
||||||
|
source:
|
||||||
|
repoURL: "git@git.odit.services:lfk/docs.git"
|
||||||
|
path: .argo
|
||||||
|
targetRevision: main
|
||||||
|
destination:
|
||||||
|
name: odit-h2
|
||||||
|
namespace: lfk
|
||||||
|
syncPolicy:
|
||||||
|
automated:
|
||||||
|
prune: true
|
||||||
|
selfHeal: true
|
||||||
|
allowEmpty: false
|
||||||
|
syncOptions:
|
||||||
|
- PruneLast=true
|
||||||
|
- CreateNamespace=true
|
||||||
|
retry:
|
||||||
|
limit: 5
|
||||||
|
backoff:
|
||||||
|
duration: 20s
|
||||||
|
factor: 2
|
||||||
|
maxDuration: 7m
|
14
legacy/.argo/cert.yaml
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
apiVersion: cert-manager.io/v1
|
||||||
|
kind: Certificate
|
||||||
|
metadata:
|
||||||
|
name: docs-lfk-de-cert
|
||||||
|
namespace: lfk
|
||||||
|
spec:
|
||||||
|
commonName: docs.lauf-fuer-kaya.de
|
||||||
|
secretName: docs-lfk-de-cert
|
||||||
|
dnsNames:
|
||||||
|
- docs.lauf-fuer-kaya.de
|
||||||
|
issuerRef:
|
||||||
|
name: letsencrypt-prod-dns
|
||||||
|
kind: ClusterIssuer
|
58
legacy/.argo/deployment.yaml
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: docs-lfk-de
|
||||||
|
namespace: lfk
|
||||||
|
labels:
|
||||||
|
app: docs-lfk-de
|
||||||
|
spec:
|
||||||
|
replicas: 1
|
||||||
|
revisionHistoryLimit: 10
|
||||||
|
strategy:
|
||||||
|
type: RollingUpdate
|
||||||
|
rollingUpdate:
|
||||||
|
maxSurge: 1
|
||||||
|
maxUnavailable: 0
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: docs-lfk-de
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: docs-lfk-de
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: docs-lfk-de
|
||||||
|
image: registry.odit.services/lfk/docs:latest
|
||||||
|
imagePullPolicy: IfNotPresent
|
||||||
|
ports:
|
||||||
|
- containerPort: 80
|
||||||
|
name: web
|
||||||
|
resources:
|
||||||
|
requests:
|
||||||
|
cpu: 50m
|
||||||
|
memory: 10Mi
|
||||||
|
limits:
|
||||||
|
cpu: 100m
|
||||||
|
memory: 128Mi
|
||||||
|
readinessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /health/
|
||||||
|
port: 80
|
||||||
|
initialDelaySeconds: 5
|
||||||
|
periodSeconds: 3
|
||||||
|
successThreshold: 4
|
||||||
|
livenessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /health/
|
||||||
|
port: 80
|
||||||
|
initialDelaySeconds: 5
|
||||||
|
periodSeconds: 3
|
||||||
|
lifecycle:
|
||||||
|
preStop:
|
||||||
|
exec:
|
||||||
|
command: ["/bin/sh", "-c", "sleep 10"]
|
||||||
|
imagePullSecrets:
|
||||||
|
- name: registry-odit-services
|
||||||
|
restartPolicy: Always
|
12
legacy/.argo/dns.yaml
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
apiVersion: externaldns.k8s.io/v1alpha1
|
||||||
|
kind: DNSEndpoint
|
||||||
|
metadata:
|
||||||
|
name: docs-lfk-de-dns
|
||||||
|
namespace: lfk
|
||||||
|
spec:
|
||||||
|
endpoints:
|
||||||
|
- dnsName: docs.lauf-fuer-kaya.de
|
||||||
|
recordTTL: 180
|
||||||
|
recordType: CNAME
|
||||||
|
targets:
|
||||||
|
- k.odit.services
|
17
legacy/.argo/ingress.yaml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
apiVersion: traefik.io/v1alpha1
|
||||||
|
kind: IngressRoute
|
||||||
|
metadata:
|
||||||
|
name: docs-lfk-de
|
||||||
|
namespace: lfk
|
||||||
|
spec:
|
||||||
|
entryPoints:
|
||||||
|
- websecure
|
||||||
|
routes:
|
||||||
|
- match: Host(`docs.lauf-fuer-kaya.de`)
|
||||||
|
kind: Rule
|
||||||
|
services:
|
||||||
|
- name: docs-lfk-de
|
||||||
|
port: 80
|
||||||
|
tls:
|
||||||
|
secretName: docs-lfk-de-cert
|
7
legacy/.argo/kustomization.yaml
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
namespace: lfk
|
||||||
|
resources:
|
||||||
|
- deployment.yaml
|
||||||
|
- service.yaml
|
||||||
|
- ingress.yaml
|
||||||
|
- cert.yaml
|
||||||
|
- dns.yaml
|
15
legacy/.argo/service.yaml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: docs-lfk-de
|
||||||
|
namespace: lfk
|
||||||
|
labels:
|
||||||
|
app: docs-lfk-de
|
||||||
|
spec:
|
||||||
|
ports:
|
||||||
|
- port: 80
|
||||||
|
name: web
|
||||||
|
selector:
|
||||||
|
app: docs-lfk-de
|
||||||
|
type: ClusterIP
|
140
legacy/.dockerignore
Normal file
@ -0,0 +1,140 @@
|
|||||||
|
# ---> VisualStudioCode
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/settings.json
|
||||||
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
!.vscode/i18n-ally-custom-framework.yml
|
||||||
|
*.code-workspace
|
||||||
|
|
||||||
|
# Local History for Visual Studio Code
|
||||||
|
.history/
|
||||||
|
|
||||||
|
# ---> Node
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||||
|
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# Snowpack dependency directory (https://snowpack.dev/)
|
||||||
|
web_modules/
|
||||||
|
|
||||||
|
# TypeScript cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Microbundle cache
|
||||||
|
.rpt2_cache/
|
||||||
|
.rts2_cache_cjs/
|
||||||
|
.rts2_cache_es/
|
||||||
|
.rts2_cache_umd/
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
.env.test
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
.parcel-cache
|
||||||
|
|
||||||
|
# Next.js build output
|
||||||
|
.next
|
||||||
|
out
|
||||||
|
|
||||||
|
# Nuxt.js build / generate output
|
||||||
|
.nuxt
|
||||||
|
dist
|
||||||
|
|
||||||
|
# Gatsby files
|
||||||
|
.cache/
|
||||||
|
# Comment in the public line in if your project uses Gatsby and not Next.js
|
||||||
|
# https://nextjs.org/blog/next-9-1#public-directory-support
|
||||||
|
# public
|
||||||
|
|
||||||
|
# vuepress build output
|
||||||
|
.vuepress/dist
|
||||||
|
|
||||||
|
# Serverless directories
|
||||||
|
.serverless/
|
||||||
|
|
||||||
|
# FuseBox cache
|
||||||
|
.fusebox/
|
||||||
|
|
||||||
|
# DynamoDB Local files
|
||||||
|
.dynamodb/
|
||||||
|
|
||||||
|
# TernJS port file
|
||||||
|
.tern-port
|
||||||
|
|
||||||
|
# Stores VSCode versions used for testing VSCode extensions
|
||||||
|
.vscode-test
|
||||||
|
|
||||||
|
# yarn v2
|
||||||
|
.yarn/cache
|
||||||
|
.yarn/unplugged
|
||||||
|
.yarn/build-state.yml
|
||||||
|
.yarn/install-state.gz
|
||||||
|
.pnp.*
|
||||||
|
|
||||||
|
yarn.lock
|
||||||
|
package-lock.json
|
||||||
|
build
|
||||||
|
|
||||||
|
*.sqlite
|
||||||
|
*.sqlite-jurnal
|
||||||
|
/docs
|
||||||
|
lib
|
||||||
|
/oss-attribution
|
||||||
|
*.tmp
|
142
legacy/.gitignore
vendored
Normal file
@ -0,0 +1,142 @@
|
|||||||
|
# ---> VisualStudioCode
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/settings.json
|
||||||
|
!.vscode/tasks.json
|
||||||
|
!.vscode/launch.json
|
||||||
|
!.vscode/extensions.json
|
||||||
|
!.vscode/i18n-ally-custom-framework.yml
|
||||||
|
*.code-workspace
|
||||||
|
|
||||||
|
# Local History for Visual Studio Code
|
||||||
|
.history/
|
||||||
|
|
||||||
|
# ---> Node
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Diagnostic reports (https://nodejs.org/api/report.html)
|
||||||
|
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
pids
|
||||||
|
*.pid
|
||||||
|
*.seed
|
||||||
|
*.pid.lock
|
||||||
|
|
||||||
|
# Directory for instrumented libs generated by jscoverage/JSCover
|
||||||
|
lib-cov
|
||||||
|
|
||||||
|
# Coverage directory used by tools like istanbul
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# nyc test coverage
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
|
||||||
|
.grunt
|
||||||
|
|
||||||
|
# Bower dependency directory (https://bower.io/)
|
||||||
|
bower_components
|
||||||
|
|
||||||
|
# node-waf configuration
|
||||||
|
.lock-wscript
|
||||||
|
|
||||||
|
# Compiled binary addons (https://nodejs.org/api/addons.html)
|
||||||
|
build/Release
|
||||||
|
|
||||||
|
# Dependency directories
|
||||||
|
node_modules/
|
||||||
|
jspm_packages/
|
||||||
|
|
||||||
|
# Snowpack dependency directory (https://snowpack.dev/)
|
||||||
|
web_modules/
|
||||||
|
|
||||||
|
# TypeScript cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Microbundle cache
|
||||||
|
.rpt2_cache/
|
||||||
|
.rts2_cache_cjs/
|
||||||
|
.rts2_cache_es/
|
||||||
|
.rts2_cache_umd/
|
||||||
|
|
||||||
|
# Optional REPL history
|
||||||
|
.node_repl_history
|
||||||
|
|
||||||
|
# Output of 'npm pack'
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# Yarn Integrity file
|
||||||
|
.yarn-integrity
|
||||||
|
|
||||||
|
# dotenv environment variables file
|
||||||
|
.env
|
||||||
|
.env.test
|
||||||
|
|
||||||
|
# parcel-bundler cache (https://parceljs.org/)
|
||||||
|
.cache
|
||||||
|
.parcel-cache
|
||||||
|
|
||||||
|
# Next.js build output
|
||||||
|
.next
|
||||||
|
out
|
||||||
|
|
||||||
|
# Nuxt.js build / generate output
|
||||||
|
.nuxt
|
||||||
|
dist
|
||||||
|
|
||||||
|
# Gatsby files
|
||||||
|
.cache/
|
||||||
|
# Comment in the public line in if your project uses Gatsby and not Next.js
|
||||||
|
# https://nextjs.org/blog/next-9-1#public-directory-support
|
||||||
|
# public
|
||||||
|
|
||||||
|
# vuepress build output
|
||||||
|
.vuepress/dist
|
||||||
|
|
||||||
|
# Serverless directories
|
||||||
|
.serverless/
|
||||||
|
|
||||||
|
# FuseBox cache
|
||||||
|
.fusebox/
|
||||||
|
|
||||||
|
# DynamoDB Local files
|
||||||
|
.dynamodb/
|
||||||
|
|
||||||
|
# TernJS port file
|
||||||
|
.tern-port
|
||||||
|
|
||||||
|
# Stores VSCode versions used for testing VSCode extensions
|
||||||
|
.vscode-test
|
||||||
|
|
||||||
|
# yarn v2
|
||||||
|
.yarn/cache
|
||||||
|
.yarn/unplugged
|
||||||
|
.yarn/build-state.yml
|
||||||
|
.yarn/install-state.gz
|
||||||
|
.pnp.*
|
||||||
|
|
||||||
|
yarn.lock
|
||||||
|
package-lock.json
|
||||||
|
build
|
||||||
|
|
||||||
|
*.sqlite
|
||||||
|
*.sqlite-jurnal
|
||||||
|
/docs
|
||||||
|
lib
|
||||||
|
/oss-attribution
|
||||||
|
*.tmp
|
||||||
|
pnpm-lock.yaml
|
||||||
|
.argo/secret.yaml
|
12
legacy/.npmignore
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
pids
|
||||||
|
logs
|
||||||
|
node_modules
|
||||||
|
npm-debug.log
|
||||||
|
coverage/
|
||||||
|
run
|
||||||
|
dist
|
||||||
|
.DS_Store
|
||||||
|
.nyc_output
|
||||||
|
.basement
|
||||||
|
config.local.js
|
||||||
|
basement_dist
|
20
legacy/.woodpecker/build.yml
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
steps:
|
||||||
|
- name: build latest
|
||||||
|
image: woodpeckerci/plugin-docker-buildx
|
||||||
|
settings:
|
||||||
|
repo: registry.odit.services/lfk/docs
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
registry: registry.odit.services
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
cache_from: registry.odit.services/lfk/docs:latest
|
||||||
|
username:
|
||||||
|
from_secret: odit-registry-builder-username
|
||||||
|
password:
|
||||||
|
from_secret: odit-registry-builder-password
|
||||||
|
secrets:
|
||||||
|
- source: odit-npm-cache-url
|
||||||
|
target: NPM_REGISTRY_URL
|
||||||
|
when:
|
||||||
|
branch: main
|
||||||
|
event: push
|
14
legacy/Dockerfile
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
FROM registry.odit.services/hub/library/node:16-alpine3.16 AS build
|
||||||
|
ARG NPM_REGISTRY_URL=https://registry.npmjs.org
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY package.json *.config.cjs *.config.js ./
|
||||||
|
RUN npm config set registry $NPM_REGISTRY_URL && npm i -g pnpm@7.29.3
|
||||||
|
RUN pnpm i
|
||||||
|
COPY . ./
|
||||||
|
RUN pnpm build
|
||||||
|
|
||||||
|
# final image
|
||||||
|
FROM registry.odit.services/library/nginx-brotli:latest
|
||||||
|
COPY --from=build /app/src/.vuepress/dist /usr/share/nginx/html
|
||||||
|
COPY ./nginx.conf /etc/nginx/nginx.conf
|
34
legacy/README.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
# @lfk/documentation
|
||||||
|
|
||||||
|
The documentation for the LfK! 'Läufersystem'.
|
||||||
|
Powered by Vuepress.
|
||||||
|
|
||||||
|
The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school).
|
||||||
|
|
||||||
|
## Quickstart 🐳
|
||||||
|
> Use this to run the documentation server via docker.
|
||||||
|
|
||||||
|
1. Clone the repo or copy the docker-compose.yml
|
||||||
|
2. Cd into the folder containing the docker-compose.yml
|
||||||
|
2. Run docker-compose: `docker-compose up -d`
|
||||||
|
3. Visit http://127.0.0.1:8080/ to check if the server is running
|
||||||
|
|
||||||
|
## Dev Setup 🛠
|
||||||
|
> Local dev setup for previewing changes.
|
||||||
|
|
||||||
|
1. Install Dependencies
|
||||||
|
```bash
|
||||||
|
yarn
|
||||||
|
```
|
||||||
|
2. Start the server
|
||||||
|
```bash
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Recommended Editor
|
||||||
|
|
||||||
|
[Visual Studio Code](https://code.visualstudio.com/)
|
||||||
|
|
||||||
|
### Recommended Extensions
|
||||||
|
|
||||||
|
* will be automatically recommended via ./vscode/extensions.json
|
6
legacy/docker-compose.yml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
version: "3.3"
|
||||||
|
services:
|
||||||
|
httpd:
|
||||||
|
build: .
|
||||||
|
ports:
|
||||||
|
- 8080:80
|
113
legacy/licenses.md
Normal file
@ -0,0 +1,113 @@
|
|||||||
|
# vuepress-plugin-flexsearch
|
||||||
|
**Author**: Ahmad Mostafa
|
||||||
|
**Repo**: https://github.com/z3by/vuepress-plugin-flexsearch
|
||||||
|
**License**: MIT
|
||||||
|
**Description**: Next-Generation full text search library for Vuepress
|
||||||
|
## License Text
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020 Ahmad Mostafa
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
# vuepress-theme-default-prefers-color-scheme
|
||||||
|
**Author**: tolking <qw13131wang@gmail.com>
|
||||||
|
**Repo**: https://github.com/tolking/vuepress-theme-default-prefers-color-scheme
|
||||||
|
**License**: MIT
|
||||||
|
**Description**: add prefers-color-scheme for vuepress default theme
|
||||||
|
## License Text
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright 2019 tolking <qw13131wang@gmail.com>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
# @odit/license-exporter
|
||||||
|
**Author**: ODIT.Services
|
||||||
|
**Repo**: https://git.odit.services/odit/license-exporter
|
||||||
|
**License**: MIT
|
||||||
|
**Description**: A simple license crawler for crediting open source work
|
||||||
|
## License Text
|
||||||
|
MIT License Copyright (c) 2020 ODIT.Services (info@odit.services)
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished
|
||||||
|
to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice (including the next
|
||||||
|
paragraph) shall be included in all copies or substantial portions of the
|
||||||
|
Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
|
||||||
|
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
|
||||||
|
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
# vuepress
|
||||||
|
**Author**: Evan You
|
||||||
|
**Repo**: https://github.com/vuejs/vuepress
|
||||||
|
**License**: MIT
|
||||||
|
**Description**: Minimalistic doc generator with Vue component based layout system
|
||||||
|
## License Text
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2018-present, Yuxi (Evan) You
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
|
|
||||||
|
|
47
legacy/nginx.conf
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
|
||||||
|
events {
|
||||||
|
}
|
||||||
|
http {
|
||||||
|
include mime.types;
|
||||||
|
sendfile on;
|
||||||
|
server {
|
||||||
|
root /usr/share/nginx/html;
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.html;
|
||||||
|
}
|
||||||
|
|
||||||
|
# --- Brotli
|
||||||
|
brotli on;
|
||||||
|
brotli_comp_level 6;
|
||||||
|
brotli_static on;
|
||||||
|
brotli_types application/atom+xml application/javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-opentype application/x-font-truetype application/x-font-ttf application/x-javascript application/xhtml+xml application/xml font/eot font/opentype font/otf font/truetype image/svg+xml image/vnd.microsoft.icon image/x-icon image/x-win-bitmap text/css text/javascript text/plain text/xml;
|
||||||
|
# --- GZIP
|
||||||
|
gzip on;
|
||||||
|
gzip_disable "msie6";
|
||||||
|
gzip_vary on;
|
||||||
|
gzip_proxied any;
|
||||||
|
gzip_comp_level 6;
|
||||||
|
gzip_buffers 16 8k;
|
||||||
|
gzip_http_version 1.1;
|
||||||
|
gzip_types application/javascript
|
||||||
|
application/rss+xml
|
||||||
|
application/vnd.ms-fontobject
|
||||||
|
application/x-font
|
||||||
|
application/x-font-opentype
|
||||||
|
application/x-font-otf
|
||||||
|
application/x-font-truetype
|
||||||
|
application/x-font-ttf
|
||||||
|
application/x-javascript
|
||||||
|
application/xhtml+xml
|
||||||
|
application/xml
|
||||||
|
font/opentype
|
||||||
|
font/otf
|
||||||
|
font/ttf
|
||||||
|
image/svg+xml
|
||||||
|
image/x-icon
|
||||||
|
text/css
|
||||||
|
text/javascript
|
||||||
|
text/plain
|
||||||
|
text/xml;
|
||||||
|
}
|
||||||
|
}
|
44
legacy/package.json
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
{
|
||||||
|
"name": "@odit/lfk-docs",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"description": "The documentation for the LfK! 'Läufersystem'.",
|
||||||
|
"main": "index.js",
|
||||||
|
"author": {
|
||||||
|
"name": "ODIT.Services",
|
||||||
|
"email": "info@odit.services",
|
||||||
|
"url": "https://odit.services"
|
||||||
|
},
|
||||||
|
"contributors": [
|
||||||
|
{
|
||||||
|
"name": "Philipp Dormann",
|
||||||
|
"email": "philipp@philippdormann.de",
|
||||||
|
"url": "https://philippdormann.de"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Nicolai Ort",
|
||||||
|
"email": "info@nicolai-ort.com",
|
||||||
|
"url": "https://nicolai-ort.com"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git@git.odit.services:lfk/docs.git"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vuepress dev src",
|
||||||
|
"build": "vuepress build src",
|
||||||
|
"licenses:export": "license-exporter --markdown"
|
||||||
|
},
|
||||||
|
"license": "CC-BY-NC-SA-4.0",
|
||||||
|
"devDependencies": {
|
||||||
|
"@odit/license-exporter": "0.0.12",
|
||||||
|
"vuepress": "1.9.9"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"vuepress-plugin-flexsearch": "0.3.0",
|
||||||
|
"vuepress-theme-default-prefers-color-scheme": "2.0.0"
|
||||||
|
},
|
||||||
|
"volta": {
|
||||||
|
"node": "16.15.1"
|
||||||
|
}
|
||||||
|
}
|
15
legacy/src/.vuepress/components/Foo/Bar.vue
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<template>
|
||||||
|
<p class="demo">
|
||||||
|
{{ msg }}
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export default {
|
||||||
|
data () {
|
||||||
|
return {
|
||||||
|
msg: 'Hello this is <Foo-Bar>'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
3
legacy/src/.vuepress/components/OtherComponent.vue
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
<template>
|
||||||
|
<p class="demo">This is another component</p>
|
||||||
|
</template>
|
15
legacy/src/.vuepress/components/demo-component.vue
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<template>
|
||||||
|
<p class="demo">
|
||||||
|
{{ msg }}
|
||||||
|
</p>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
export default {
|
||||||
|
data() {
|
||||||
|
return {
|
||||||
|
msg: 'Hello this is <demo-component>'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
172
legacy/src/.vuepress/config.js
Normal file
@ -0,0 +1,172 @@
|
|||||||
|
const { description } = require('../../package')
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
locales: {
|
||||||
|
'/': {
|
||||||
|
lang: 'de-DE',
|
||||||
|
title: 'LfK! Dokumentation',
|
||||||
|
description: 'Dokumentation für das Lauf für Kaya! Läufersystem'
|
||||||
|
},
|
||||||
|
'/en/': {
|
||||||
|
lang: 'en-US',
|
||||||
|
title: 'LfK! Documentation',
|
||||||
|
description: 'The official documentation for the LfK! "Läufersystem"'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
head: [
|
||||||
|
['meta', { name: 'theme-color', content: '#3eaf7c' }],
|
||||||
|
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
|
||||||
|
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }]
|
||||||
|
],
|
||||||
|
theme: 'default-prefers-color-scheme',
|
||||||
|
themeConfig: {
|
||||||
|
repo: '',
|
||||||
|
editLinks: false,
|
||||||
|
docsDir: '',
|
||||||
|
editLinkText: '',
|
||||||
|
lastUpdated: false,
|
||||||
|
locales: {
|
||||||
|
'/': {
|
||||||
|
selectText: 'Sprachen',
|
||||||
|
label: 'Deutsch (German)',
|
||||||
|
nav: [
|
||||||
|
{
|
||||||
|
text: 'Für Nutzer',
|
||||||
|
link: '/users/',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Für Admins',
|
||||||
|
link: '/admins/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Über den Selfservice',
|
||||||
|
link: '/selfservice/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Scannerstationen',
|
||||||
|
link: '/scanstations/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Beamershow',
|
||||||
|
link: '/beamershow/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Source Code',
|
||||||
|
link: 'https://git.odit.services/lfk'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
sidebar: {
|
||||||
|
'/users/': [
|
||||||
|
{
|
||||||
|
title: 'Nutzerdokumentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
'',
|
||||||
|
'accounts',
|
||||||
|
'organizations',
|
||||||
|
'teams',
|
||||||
|
'runners',
|
||||||
|
'runner_import',
|
||||||
|
'donors',
|
||||||
|
'donations',
|
||||||
|
'cards',
|
||||||
|
'sponsoring_contracts',
|
||||||
|
'tracks',
|
||||||
|
'scans',
|
||||||
|
'scanstations'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/admins/': [
|
||||||
|
{
|
||||||
|
title: 'Administrative Dokumentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
'',
|
||||||
|
'quickstart',
|
||||||
|
'users',
|
||||||
|
'usergroups'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/selfservice/': [
|
||||||
|
{
|
||||||
|
title: 'Selfservice Dokumentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
'',
|
||||||
|
'org_selfservice'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/scanstations/': [
|
||||||
|
{
|
||||||
|
title: 'Scannerstation Dokumentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
'',
|
||||||
|
'install',
|
||||||
|
'config',
|
||||||
|
'config_scanners',
|
||||||
|
'hardware'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/beamershow/': [
|
||||||
|
{
|
||||||
|
title: 'Beamershow Dokumentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
'',
|
||||||
|
'config'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
'/en/': {
|
||||||
|
selectText: 'Languages',
|
||||||
|
label: 'English',
|
||||||
|
nav: [
|
||||||
|
{
|
||||||
|
text: 'For Users',
|
||||||
|
link: '/en/users/',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'For Admins',
|
||||||
|
link: '/en/admins/'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: 'Source Code',
|
||||||
|
link: 'https://git.odit.services/lfk'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
sidebar: {
|
||||||
|
'/en/users/': [
|
||||||
|
{
|
||||||
|
title: 'User documentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
''
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/en/admins/': [
|
||||||
|
{
|
||||||
|
title: 'Admin documentation',
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
''
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
plugins: [
|
||||||
|
'@vuepress/plugin-back-to-top',
|
||||||
|
'@vuepress/plugin-medium-zoom',
|
||||||
|
'flexsearch'
|
||||||
|
]
|
||||||
|
}
|
14
legacy/src/.vuepress/enhanceApp.js
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
/**
|
||||||
|
* Client app enhancement file.
|
||||||
|
*
|
||||||
|
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
|
||||||
|
*/
|
||||||
|
|
||||||
|
export default ({
|
||||||
|
Vue, // the version of Vue being used in the VuePress app
|
||||||
|
options, // the options for the root Vue instance
|
||||||
|
router, // the router instance for the app
|
||||||
|
siteData // site metadata
|
||||||
|
}) => {
|
||||||
|
// ...apply enhancements for the site.
|
||||||
|
}
|
11
legacy/src/.vuepress/public/files/class_with_middlename.csv
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
Vorname;Mittelname;Nachname;Klasse
|
||||||
|
Lorem ;Impum;dolor;1A
|
||||||
|
sit;;amet;1A
|
||||||
|
consetetur;sadipscing;elitr;1A
|
||||||
|
Max;;Mustermann;1A
|
||||||
|
Maxime;;Mustermann;2A
|
||||||
|
Peter;Emanuel ;Lustig;2A
|
||||||
|
Robert;;Schmidtt;2A
|
||||||
|
Guten;;Morgen;2A
|
||||||
|
Wunderschönen;Guten;Morgen;3A
|
||||||
|
Tolle;;Ümläütä;3A
|
|
BIN
legacy/src/.vuepress/public/files/class_with_middlename.xlsx
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
Vorname;Nachname;Klasse
|
||||||
|
Lorem ;dolor;1A
|
||||||
|
sit;amet;1A
|
||||||
|
consetetur;elitr;1A
|
||||||
|
Max;Mustermann;1A
|
||||||
|
Maxime;Mustermann;2A
|
||||||
|
Peter;Lustig;2A
|
||||||
|
Robert;Schmidtt;2A
|
||||||
|
Guten;Morgen;2A
|
||||||
|
Wunderschönen;Morgen;3A
|
||||||
|
Tolle;Ümläütä;3A
|
|
BIN
legacy/src/.vuepress/public/files/class_without_middlename.xlsx
Normal file
BIN
legacy/src/.vuepress/public/files/scannerconfig.docx
Normal file
BIN
legacy/src/.vuepress/public/files/scannerconfig.pdf
Normal file
After Width: | Height: | Size: 18 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 23 KiB |
After Width: | Height: | Size: 18 KiB |
After Width: | Height: | Size: 20 KiB |
After Width: | Height: | Size: 152 KiB |
After Width: | Height: | Size: 65 KiB |
After Width: | Height: | Size: 77 KiB |
BIN
legacy/src/.vuepress/public/images/service_interaction.png
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
legacy/src/.vuepress/public/logo.png
Normal file
After Width: | Height: | Size: 31 KiB |
8
legacy/src/.vuepress/styles/index.styl
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* Custom Styles here.
|
||||||
|
*
|
||||||
|
* ref:https://v1.vuepress.vuejs.org/config/#index-styl
|
||||||
|
*/
|
||||||
|
|
||||||
|
.home .hero img
|
||||||
|
max-width 450px!important
|
10
legacy/src/.vuepress/styles/palette.styl
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
/**
|
||||||
|
* Custom palette here.
|
||||||
|
*
|
||||||
|
* ref:https://v1.vuepress.vuejs.org/zh/config/#palette-styl
|
||||||
|
*/
|
||||||
|
|
||||||
|
$accentColor = #3eaf7c
|
||||||
|
$textColor = #2c3e50
|
||||||
|
$borderColor = #eaecef
|
||||||
|
$codeBgColor = #282c34
|
26
legacy/src/admins/README.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
# Admins
|
||||||
|
|
||||||
|
Dieser Teil der Dokumentation befasst sich mit der Installation, Konfiguration und Bedienung des Läufersystems für normale Admins.
|
||||||
|
Solltest du an der Bedienung für normale Nutzer interessiert sein schau doch mal in den <router-link to="./users">Nutzerbereich</router-link>.
|
||||||
|
|
||||||
|
## Services
|
||||||
|
> Eine kurze Übersicht über die verschiedenen Services des Systems und ihre Interaktion
|
||||||
|
|
||||||
|
* Backend: Beinhaltet die Hauptlogik und verwaltet die Daten (via Datenbankanbindung)
|
||||||
|
* Mailer: Versendet auf Basis von HTML-Templates automatisiert Mails
|
||||||
|
* Document-Server: Erstellt PDFs (Urkunden, Läuferkarten, Sponsoringerklärungen) aus HTML-Templates
|
||||||
|
* Frontend: Verwaltungsoberfläche für die Admins und Benutzer:innen des Läufersystems
|
||||||
|
* Selfservice: Portal in dem sich Bürger- und Firmenläufer:innen registrieren und ihre Daten einsehen können
|
||||||
|
* Beamershow: Zeigt aktuelle Statistiken und Toplisten zum Event an
|
||||||
|
* Scanclient: Software für die Scannerstationen
|
||||||
|
* Docs: Diese Dokumentation
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
> Ein paar der meist gestellten Fragen vorab
|
||||||
|
|
||||||
|
### Warum sehe ich eine Seite nicht?
|
||||||
|
Nutzer sehen nur die Seiten im System, für die sie Berechtigungen haben.
|
||||||
|
Solltest du eine Seite nicht sehen bist du vermutlich nicht voll als Admin berechtigt.
|
19
legacy/src/admins/quickstart.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Schnellstart
|
||||||
|
> Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig!
|
||||||
|
> Um das System für produktive Zwecke einzusetzen schau dir bitte die <router-link to="./installation">Installationsanleitung</router-link> an.
|
||||||
|
|
||||||
|
## Voraussetzungen
|
||||||
|
Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast.
|
||||||
|
Die Installationsanleitungen dafür findest du hier:
|
||||||
|
* [Docker](https://docs.docker.com/get-docker/)
|
||||||
|
* [Docker-Compose](https://docs.docker.com/compose/install/)
|
||||||
|
|
||||||
|
## Das ganze System
|
||||||
|
> Du willst das ganze System (backend, fronten, document-server) schnell aufsetzen.
|
||||||
|
|
||||||
|
1. Klone das lfk/deployment git repo von: https://git.odit.services/lfk/deployment (oder lade es herunter)
|
||||||
|
2. Navigiere nach `docker-compose/full_stack`: `cd deployment/docker-compose/full_stack`
|
||||||
|
3. Starte das System mit `docker-compose up`
|
||||||
|
4. Nachdem alles gestartet ist ist kannst du das Frontend aufrufen: http://localhost:4010 (backend: http://localhost:4010/api/, document-server: http://localhost:4010/documents/)
|
||||||
|
|
||||||
|
Bei Bedarf können die Ports und andere Einstellungen im docker-compose.yml angepasst werden.
|
36
legacy/src/admins/usergroups.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# Benutzergruppen
|
||||||
|
|
||||||
|
Als Admin kannst du Benutzergruppen anlegen und Benutzer:innen in diese Einsortieren.
|
||||||
|
Die Benutzer:innen erben dadurch die Berechtigungen aller Gruppen, in denen sie sind.
|
||||||
|
|
||||||
|
So kannst du z.B. alle Admins in die `ADMINS` Gruppe packen, anstatt jeder Benutzer:in langwierig alle Berechtigungen von Hand zuzuweisen.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um eine neue Benutzergruppe anzulegen öffne im Läufersystem die Seite `Benutzergruppen`.
|
||||||
|
Über den Button `Neue Gruppe erstellen` kannst du eine neue Benutzergruppe erstellen.
|
||||||
|
Dabei kannst du der Gruppe einen Namen und (optional) eine Beschreibung geben.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Benutzergruppe zu bearbeiten kannst du in der Benutzergruppenübersicht den Button `Details` für die gewünschte Gruppe anklicken.
|
||||||
|
In der Übersicht für diese Benutzergruppe kannst du nun den Namen und die Beschreibung anpassen und Berechtigungen einsehen oder bearbeiten.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
### Berechtigungen
|
||||||
|
> Für die Berechtigung einer Benutzergruppe gibt es eine extra Seite.
|
||||||
|
Um die Berechtigungen einer Gruppe zu bearbeiten kannst du auf der Detailseite der Gruppe auf `Berechtigungen bearbeiten` klicken.
|
||||||
|
Auf der Berechtigungsseite gibt es zwei Spalten: `Verfügbare`(Berechtigungen, die die Gruppe nicht hat) und `Gewährt`(Berechtigungen, die die Gruppe hat).
|
||||||
|
Du kannst hier über die Buttons `+` und `-` die Berechtigungen erteilen oder wegnehmen.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst eine Benutzergruppe entweder aus der Benutzergruppenübersicht oder der Benutzergruppendetailansicht löschen.
|
||||||
|
> Dabei wird nur die Benutzergruppe samt Berechtigungen gelöscht, nicht ihre Benutzer:innen.
|
||||||
|
|
||||||
|
### In der Benutzergruppenübersicht
|
||||||
|
Klick bei der gewünschten Benutzergruppe auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Benutzergruppe wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Benutzergruppendetailansicht
|
||||||
|
Klick bei der gewünschten Benutzergruppe auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Gruppe löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Benutzergruppe wirklich löschen oder abbrechen willst.
|
35
legacy/src/admins/users.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
# Benutzer:innen
|
||||||
|
|
||||||
|
Als Admin kannst du Benutzer:innen anlegen.
|
||||||
|
Benutzer:innen können sich in der Läuferverwaltung und am Backend (API) anmelden und im Rahmen ihrer Berechtigungen damit Arbeiten.
|
||||||
|
Benutzer:innen kannst du Berechtigungen direkt zuweisen oder sie beliebig vielen Gruppen zuweisen, von denen sie dann Berechtigungen erben.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um eine neue Benutzer:in anzulegen öffne im Läufersystem die Seite `Benutzer`.
|
||||||
|
Über den Button `Benutzer anlegen` kannst du eine neue Benutzer:in erstellen.
|
||||||
|
Dabei kannst du dem Kontakt eine(n) Namen, Benutzernamen, Passwort und E-Mail Adresse geben.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Benutzer:in zu bearbeiten kannst du in der Benutzerübersicht den Button `Details` für die gewünschte Benutzer:in anklicken.
|
||||||
|
In der Übersicht für diesen Kontakt kannst du nun den Namen, Benutzernamen, die E-Mail, Gruppen und Berechtigungen anpassen.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
### Berechtigungen
|
||||||
|
> Für die Berechtigung einer Benutzer:in gibt es eine extra Seite.
|
||||||
|
Um die Berechtigungen einer Benutzer:in zu bearbeiten kannst du auf der Detailseite der Benutzer:in auf `Berechtigungen bearbeiten` klicken.
|
||||||
|
Auf der Berechtigungsseite gibt es drei Spalten: `Verfügbare`(Berechtigungen, die die Benutzer:in nicht direkt hat), `Direkt erteilte`(Berechtigungen, die die Benutzer:in direkt hat) und `geerbte`(Berechtigungen, die die Benutzer:in von ihren Benutzergruppen geerbt hat).
|
||||||
|
Du kannst hier über die Buttons `+` und `-` die direkten Berechtigungen erteilen oder wegnehmen.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst eine Benutzer:in entweder aus der Benutzerübersicht oder der Benutzerdetailansicht löschen.
|
||||||
|
> Dabei wird nur die Benutzer:in samt Berechtigungen gelöscht.
|
||||||
|
|
||||||
|
### In der Benutzerübersicht
|
||||||
|
Klick bei der gewünschten Benutzer:in auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Benutzer:in wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Benutzerdetailansicht
|
||||||
|
Klick bei der gewünschten Benutzer:in auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Benutzer:in löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Benutzer:in wirklich löschen oder abbrechen willst.
|
17
legacy/src/beamershow/README.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Beamershow
|
||||||
|
|
||||||
|
Die Beamershow zeigt live Statistiken zum aktuellen Event an.
|
||||||
|
Wie der Name schon andeutet ist sie dafür gedacht mit einem Beamer vor Ort auf eine (Lein)Wand projeziert zu werden.
|
||||||
|
|
||||||
|
Sie sollte im Normalfall immer unter `<läufersystem>/beamershow` erreichbar sein, mehr dazu unter <router-link to="./config">Konfiguration</router-link>
|
||||||
|
|
||||||
|
## Seiten/Informationen
|
||||||
|
> Die Beamershow umfasst folgende Seiten/Abschnitte
|
||||||
|
* Allgemeines
|
||||||
|
* Anzahl an Läufer:innen
|
||||||
|
* Bisher insgesamt erlaufene Kilometer
|
||||||
|
* Aktuelle Spendengesamtsumme
|
||||||
|
* Top 10 Läufer nach Distanz
|
||||||
|
* Top 10 Läufer nach schnellster Rundenzeit
|
||||||
|
* Top 10 Organisationen nach Distanz
|
||||||
|
* Top 10 Teams nach Distanz
|
12
legacy/src/beamershow/config.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# Konfiguration
|
||||||
|
> Wie man die Beamershow konfiguriert
|
||||||
|
|
||||||
|
## Start
|
||||||
|
Wenn du die Beamershow öffnest wirst du als erstes nach dem API Endpunkt gefragt - diese entspricht der URL des Läufersystems (z.B.: `https://dev.lauf-fuer-kaya.de`).<br>
|
||||||
|
Als nächstes musst du noch einen Client Token gefragt, den du von deinem Admin bekommst.
|
||||||
|
|
||||||
|
Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und die Beamershow wird gestartet.
|
||||||
|
|
||||||
|
## Konfiguration ändern
|
||||||
|
Tippe `cnf` auf einer beliebigen Seite der Beamershow.<br>
|
||||||
|
Du wirst sofort von der Beamershow abbemeldet und kannst so einen neuen API Endpunkt und Client Token angeben.
|
3
legacy/src/en/admins/README.md
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
# Admins
|
||||||
|
|
||||||
|
TODO:
|
15
legacy/src/en/index.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
home: true
|
||||||
|
heroImage: /logo.png
|
||||||
|
tagline: The documentation for the LfK! "Läufersystem".
|
||||||
|
actionText: Quickstart for users →
|
||||||
|
actionLink: ./users/
|
||||||
|
# features:
|
||||||
|
# - title: Feature 1 Title
|
||||||
|
# details: Feature 1 Description
|
||||||
|
# - title: Feature 2 Title
|
||||||
|
# details: Feature 2 Description
|
||||||
|
# - title: Feature 3 Title
|
||||||
|
# details: Feature 3 Description
|
||||||
|
footer: Made by ODIT.Services with ❤️
|
||||||
|
---
|
11
legacy/src/en/users/README.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Introduction
|
||||||
|
|
||||||
|
This part of the documentation describes the interaction with the system for normal users.
|
||||||
|
If you're interested in installing, configuring or administrating the system take a look at the <router-link to="../admins">admins section</router-link>.
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
> A couple of frequently asked questiones.
|
||||||
|
|
||||||
|
### Why can't i see the page XY?
|
||||||
|
Users can only see pages if they have the right permissions.
|
||||||
|
If you can't view a page that you need to, please contact your administrator.
|
18
legacy/src/index.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
home: true
|
||||||
|
heroImage: /logo.png
|
||||||
|
tagline: Die Dokumentation für das LfK! Läufersystem
|
||||||
|
actionText: Schnellstart für Nutzer →
|
||||||
|
actionLink: /users/
|
||||||
|
# features:
|
||||||
|
# - title: Feature 1 Title
|
||||||
|
# details: Feature 1 Description
|
||||||
|
# - title: Feature 2 Title
|
||||||
|
# details: Feature 2 Description
|
||||||
|
# - title: Feature 3 Title
|
||||||
|
# details: Feature 3 Description
|
||||||
|
---
|
||||||
|
::: slot footer
|
||||||
|
Made by [ODIT.Services](https://odit.services/?ref=lfk-docs) with ❤️ <br>
|
||||||
|
Developed for [Lauf für Kaya](https://lauf-fuer-kaya.de) | [Imprint](https://lauf-fuer-kaya.de/impressum) | [Privacy](https://lauf-fuer-kaya.de/datenschutz)
|
||||||
|
:::
|
13
legacy/src/scanstations/README.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Über die Scannerstationen
|
||||||
|
|
||||||
|
Die Scannerstation ist die Kombination aus Hardware und Software, die dazu genutzt wird Läuferkarten zu scannen und damit gelaufene Distanzen im System zu erfassen.
|
||||||
|
Wir schreiben grundsätzlich keine Hardware oder Software vor - stellen aber selbst eine Software bereit und empfehlen Hardware.
|
||||||
|
|
||||||
|
Die API für Scannerstationen im Läufersystem ist grundsätzlich so gestaltet, dass Scans live erfasst und validiert (Läufer, Track, Rundenzeit) werden.
|
||||||
|
|
||||||
|
## Bedienung
|
||||||
|
> Die Bedienung nach der <router-link to="./config.html">Konfiguration</router-link>
|
||||||
|
|
||||||
|
Die Bedienung der Software als Helfer an der Scannerstation ist sehr einfach:
|
||||||
|
1. Scannen
|
||||||
|
2. Auf dem Bildschirm sehen, ob der Scan valide war
|
17
legacy/src/scanstations/config.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Konfiguration
|
||||||
|
> Wie man die Scanclient Software konfiguriert
|
||||||
|
|
||||||
|
## Start
|
||||||
|
Wenn du die Scanclient Software öffnest wirst du als erstes nach einem API Endpunkt gefragt.
|
||||||
|
Hier musst du die URL deines LfK-Backends eintragen (z.B.: `https://dev.lauf-fuer-kaya.de`).
|
||||||
|
|
||||||
|
Als nächstes musst du noch einen Client Token gefragt -> <router-link to="../users/scanstations.html">So kommst du an einen Client token</router-link><br>
|
||||||
|
Solltest du dich beim API-Endpunkt vertippt haben kannst du hier auch `rst` eingeben, um diesen nochmal zu setzen.
|
||||||
|
|
||||||
|
Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und der Scanclient wird gestartet.
|
||||||
|
|
||||||
|
## Konfiguration ändern
|
||||||
|
Tippe `cnf` in das Läuferkarten-Feld und bestätige mit Enter.
|
||||||
|
Jetzt öffnet sich die Konfigurationsübersicht, in der alle Details zur Konfigurierten Scannerstation aufgelistet sind.
|
||||||
|
Wenn du die Software vom Läufersystem abmelden oder den Token ändern willst klicke auf "Log out from this Client".
|
||||||
|
Wenn du fertig bist kannst du über den Button "Back to Scanner" wieder in den Scan-Modus wechseln.
|
31
legacy/src/scanstations/config_scanners.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Scannerkonfiguration
|
||||||
|
> Achtung: Diese Konfiguratiuon wurde nur mit GD4130-BK/WH USB Scannern getestet
|
||||||
|
> Download als PDF: [Scannerkonfiguration.pdf](/files/scannerconfig.pdf)
|
||||||
|
|
||||||
|
## 1. Werkseinstellungen wiederherstellen
|
||||||
|

|
||||||
|
|
||||||
|
## 2. Programming Mode Aktivieren
|
||||||
|

|
||||||
|
|
||||||
|
## 3. Nur EAN-13 scannen (optional)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
## 4. EAN13 Check-Zahl überprüfen, aber nicht übertragen
|
||||||
|

|
||||||
|
|
||||||
|
## 5. Scanner auf always on stellen (optional)
|
||||||
|

|
||||||
|
## 6. Programming Mode Verlassen
|
||||||
|

|
||||||
|
|
||||||
|
## 7. Beep ausschalten (optional)
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
## 8. Tastatur auf Deutsch stellen (optional)
|
||||||
|

|
||||||
|

|
||||||
|

|
12
legacy/src/scanstations/hardware.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# Hardwareempfehlungen
|
||||||
|
> Known-good Hardware, die wir für die Scannerstationen empfehlen können
|
||||||
|
|
||||||
|
## Computer
|
||||||
|
* Raspberry Pi 3 oder neuer
|
||||||
|
* Prozessor: Minimum: Intel Core 2 Duo
|
||||||
|
* Arbeitsspeicher: Minimum 4GB
|
||||||
|
|
||||||
|
## Barcodescanner
|
||||||
|
* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D)
|
||||||
|
* Datalogic Gryphon GD4200 USB Scanner (1D)
|
||||||
|
* Datalogic Gryphon GD4400 USB Scanner (2D)
|
35
legacy/src/scanstations/install.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
# Installation
|
||||||
|
|
||||||
|
Es gibt aktuell drei Varianten, um die Scanclient Software zu installieren/nutzen
|
||||||
|
* Als Livesystem starten (empfohlen)
|
||||||
|
* Für Windows herunterladen
|
||||||
|
* Für Linux herunterladen
|
||||||
|
|
||||||
|
## Livesystem
|
||||||
|
> Empfohlene Variante
|
||||||
|
|
||||||
|
1. Lade dir die aktuellste Version des Betriebssystems herunter: [Versionsübersicht](https://git.odit.services/lfk/scanclient-live/releases)
|
||||||
|
* Den neusten (obersten) Release auswählen.
|
||||||
|
* Unter "Downloads" die Datei lfk-scanclient-live_X.Y.Z_x64.zip anklicken
|
||||||
|
2. Einen USB-Stick einstecken und als FAT32 formatieren (Achtung: Hierbei gehen alle Daten verloren, die auf dem Stick sind)
|
||||||
|
3. Die ZIP-Datei auf den Stick kopieren
|
||||||
|
4. Die ZIP Datei auf dem Stick entpacken -> Du solltest einen neuen Order `slax` erhalten
|
||||||
|
5. Den Stick bootfähig machen
|
||||||
|
* Windows: Die Datei `USBSTICK\slax\boot\bootinst.bat` als Administrator ausführen
|
||||||
|
* Linux/Mac: Die Datei `USBSTICK/slax/boot/bootinst.sh` mit Root-Rechten (sudo) ausführen
|
||||||
|
6. Den Stick in den Rechner deiner Wahl einstecken und von ihm Starten
|
||||||
|
* Bei den meisten Rechner: Beim Hochfahren F12 drücken und dann den USB-Stick auswähren
|
||||||
|
|
||||||
|
## Windows
|
||||||
|
1. Programm aus dem Git Repo herunterladen: [Versionsübersicht](https://git.odit.services/lfk/scanclient-electron/releases)
|
||||||
|
* Den neusten (obersten) Release auswählen.
|
||||||
|
* Unter "Downloads" die Datei @lfk-scanclient-electron-win32-x64.zip anklicken
|
||||||
|
2. Die ZIP-Datei entpacken
|
||||||
|
3. Die Datei `@lfk-scanclient-electron.exe` öffnen
|
||||||
|
|
||||||
|
## Linux
|
||||||
|
1. Programm aus dem Git Repo herunterladen: [Versionsübersicht](https://git.odit.services/lfk/scanclient-electron/releases)
|
||||||
|
* Den neusten (obersten) Release auswählen.
|
||||||
|
* Unter "Downloads" die Datei @lfk-scanclient-electron-linux-x64.zip anklicken
|
||||||
|
2. Die ZIP-Datei entpacken
|
||||||
|
3. Die Datei `@lfk-scanclient-electron` öffnen
|
13
legacy/src/selfservice/README.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# Über den Selfservice
|
||||||
|
|
||||||
|
Der Selfservice bietet Läufer:innen sich selbst für den Lauf zu registrieren und ihre eigenen Daten einzusehen.
|
||||||
|
Genauer gibt es folgende Funktionen:
|
||||||
|
* Registrierung für Bürgerläufer
|
||||||
|
* Registrierung für Firmenläufer
|
||||||
|
* Einsehen der eigenen Daten
|
||||||
|
* Stammdaten: Vorname, Mittelname, Nachname, E-Mail Adresse, Telefonnummer
|
||||||
|
* Rundenzeiten
|
||||||
|
* Herunterladen der eigenen Läuferurkunde
|
||||||
|
* Restloses löschen der eigenen Daten aus dem System
|
||||||
|
|
||||||
|
Achtung: Damit der Selfservice für Bürgerläufer funktioniert, muss die automatisch generierte Bürgerlauf-Organisation existieren!
|
12
legacy/src/selfservice/org_selfservice.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
# Selfservice für Organisationen
|
||||||
|
Läufer:innen von Firmen und andere Institutionen können sich über den Selfservice für den Lauf registrieren.
|
||||||
|
So werden sie automatisch im System angelegt und bekommen per Mail einen Link zugesendet, mit dem sie ihre persönlichen Daten und Rundenzeiten ansehen können.
|
||||||
|
|
||||||
|
## Selfservice für eine Organisations freischalten
|
||||||
|
> Achtung: Nur Teammitglider können Organisationen für die Registrierung über den Selfservice freischalten.
|
||||||
|
> Solltest du zu einer Organisation gehören, die sich freischalten lassen will wende dich bitte an das Laufteam.
|
||||||
|
|
||||||
|
1. Rufe im Läufersystem die Seite `Organisationen auf`
|
||||||
|
2. Klicke für die gewünschte Organisation auf den Button `Details`
|
||||||
|
3. Setze einen Haken bei `Selfservice Registrierung`, falls dieser noch nicht gesetzt ist und klicke auf `Änderungen speichern`
|
||||||
|
4. Kopiere den Registrierungslink für die Organisation
|
11
legacy/src/users/README.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Einleitung
|
||||||
|
|
||||||
|
Dieser Teil der Dokumentation befasst sich mit der Bedienung des Läufersystems für normale Nutzer:innen.
|
||||||
|
Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den <router-link to="../admins">Admin</router-link> Bereich.
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
> Ein paar der meist gestellten Fragen vorab
|
||||||
|
|
||||||
|
### Warum sehe ich eine Seite nicht?
|
||||||
|
Nutzer sehen nur die Seiten im System, für die sie Berechtigungen haben.
|
||||||
|
Solltest du eine Seite nicht sehen, die du brauchst melde dich bitte bei deinem Admin.
|
22
legacy/src/users/accounts.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
# Nutzerkonten
|
||||||
|
|
||||||
|
## Registrieren
|
||||||
|
> Aktuell können nur Admins neue Benutzer:innen hinzufügen - bitte kontaktiere deinen Admin.
|
||||||
|
|
||||||
|
## Passwort vergessen
|
||||||
|
> Kein Problem!
|
||||||
|
|
||||||
|
1. Die Login Seite des Systems aufrufen
|
||||||
|
2. Auf `Passwort vergessen?` klicken
|
||||||
|
3. Deine E-Mail Adresse eingeben
|
||||||
|
4. Du bekommst eine Mail, du sie hast auf den Link in der Mail klicken
|
||||||
|
5. Das neue Passwort setzen
|
||||||
|
6. Wieder normal anmelden
|
||||||
|
|
||||||
|
## Einstellungen ändern
|
||||||
|
> Du möchtest deinen Namen, E-Mail oder Passwort ändern
|
||||||
|
|
||||||
|
1. Melde dich im Läufersystem an
|
||||||
|
2. Gehe auf die Seite `Einstellungen`
|
||||||
|
3. Pass deine Nutzereinstellungen an
|
||||||
|
4. Klicke auf `Speichern`
|
61
legacy/src/users/cards.md
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
# Läuferkarten
|
||||||
|
|
||||||
|
Läuferkarten dienen dazu <router-link to="./scans">Trackscans</router-link> für <router-link to="./runners">Läufer:innen</router-link> durch <router-link to="./scanstations">Scannerstationen</router-link> zu erzeugen
|
||||||
|
Läuferkarten können entweder fest zu einer Läufer:in gehören, oder als Blankokarten genutzt werden, die frei beliebigen Läufer:innen zugewiesen werden können.
|
||||||
|
## Anlegen
|
||||||
|
Du kannst Läuferkarten entweder manuell anlegen oder automatisch von System generieren lassen.
|
||||||
|
Auch Blankokarten kannst du beliebig viele vom System generieren lassen.
|
||||||
|
|
||||||
|
### Manuel anlegen
|
||||||
|
Um eine neue Läuferkarte anzulegen öffne im Läufersystem die Seite `Läuferkarten`.
|
||||||
|
Über den Button `Karte erstellen` kannst du eine neue Läuferkarte erstellen.
|
||||||
|
Hier kannst du eine Läuferin auswählen (musst es aber nicht).
|
||||||
|
Sobald du alles angegeben hast kannst du mit dem Button `Erstellen` die Läuferkarte anlegen.
|
||||||
|
|
||||||
|
### Blankokarten generieren
|
||||||
|
Um neue Blankokarten anzulegen öffne im Läufersystem die Seite `Läuferkarten`.
|
||||||
|
Über den Button `Blankokarten erstellen` kannst du neue Blankokarten erstellen.
|
||||||
|
Hier kannst du auswählen, wie viele Karten generiert werden sollen.
|
||||||
|
Sobald du alles angegeben hast kannst du mit dem Button `Erstellen` die Blankokarten generieren.
|
||||||
|
|
||||||
|
### Für Läufer:innen
|
||||||
|
|
||||||
|
In der Läuferübersicht kannst du beliebig viele Läufer:innen auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Läuferliste der Button `Läuferkarten generieren`.
|
||||||
|
Sobald du ihn anklickst kannst du die Sprache für die Läuferkarten PDFs auswählen.
|
||||||
|
Daraufhin werden die Läuferkarten angelegt, die PDFs generiert und heruntergeladen.
|
||||||
|
|
||||||
|
### Für Teams
|
||||||
|
|
||||||
|
#### Für Teams in der Teamübersicht
|
||||||
|
In der Teamübersicht kannst du beliebig viele Teams auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Teamliste der Button `Läuferkarten generieren`.
|
||||||
|
Sobald du ihn anklickst kannst du die Sprache für die Läuferkarten PDFs auswählen.
|
||||||
|
Daraufhin werden die Läuferkarten für alle Läufer:innen der Teams angelegt, die PDFs generiert und heruntergeladen.
|
||||||
|
|
||||||
|
#### Für einzelne Teams in der Teamdetailansicht
|
||||||
|
Um Läuferkarten für alle Läufer:innen eines einzelne Teams zu generieren kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken.
|
||||||
|
Dann kannst du auf der Detailansicht einfach den Button `Läuferkarten generieren` anklicken und die gewünschte Sprache auswählen - daraufhin werden die Läuferkarten generiert und heruntergeladen.
|
||||||
|
|
||||||
|
### Für Organisationen
|
||||||
|
|
||||||
|
#### Für Organisationen in der Organisationsübersicht
|
||||||
|
In der Organisationsübersicht kannst du beliebig viele Organisationen auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Organisationsliste der Button `Läuferkarten generieren`.
|
||||||
|
Sobald du ihn anklickst kannst du die Sprache für die Läuferkarten PDFs auswählen.
|
||||||
|
Daraufhin werden die Läuferkarten für alle Läufer:innen der Organisation (inkl. Teams) angelegt, die PDFs generiert und heruntergeladen.
|
||||||
|
|
||||||
|
#### Für einzelne Organisationen in der Teamdetailansicht
|
||||||
|
Um Läuferkarten für alle Läufer:innen einer einzelnen Organisation (inklusive ihrer Teams) zu generieren kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken.
|
||||||
|
Dann kannst du auf der Detailansicht einfach den Button `Läuferkarten generieren` anklicken und die gewünschte Sprache auswählen - daraufhin werden die Läuferkarten generiert und heruntergeladen.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Läuferkarte zu bearbeiten öffne im Läufersystem die Seite `Läuferkarten`.
|
||||||
|
In der Läuferkartenübersicht kannst du den Button `Details` für die gewünschte Läuferkarte anklicken.
|
||||||
|
Nun kannst du die Karte einer anderen Läufer:in zuordnen oder sie deaktivieren.
|
||||||
|
Sobald du alles angepasst hast kannst du mit dem Button `Änderungen speichern` die Änderungen übernehmen.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
Um eine Läuferkarte zu bearbeiten öffne im Läufersystem die Seite `Läuferkarten`.
|
||||||
|
In der Läuferkartenübersicht kannst du den Button `Löschen` für die gewünschte Läuferkarte anklicken.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Karte wirklich löschen oder abbrechen willst.
|
30
legacy/src/users/contacts.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
# Kontakte
|
||||||
|
|
||||||
|
Kontakte dienen dem Customer Relation Management (CRM) und können beliebig vielen <router-link to="./teams">Teams</router-link> und <router-link to="./organizations">Organisationen</router-link> zugeordnet werden.
|
||||||
|
Achtung: Ein(e) Team/Organisation kann immer nur einen Kontakt haben.
|
||||||
|
|
||||||
|
Aktuell dienen die Kontakte nur der Dokumentation, in Zukunft solle es aber auch möglich sein einem Kontakt per Knopfdruck die Urkunden für all seine Teams/Orgs per Mail zu schicken.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um einen neuen Kontakt anzulegen öffne im Läufersystem die Seite `Kontakt`.
|
||||||
|
Über den Button `Kontakt erstellen` kannst du einen neuen Kontakt erstellen.
|
||||||
|
Dabei kannst du dem Kontakt eine(n) Namen, Telefonnummer und E-Mail Adresse geben und sie beliebig vielen Gruppen (Teams/Organisationen) zuweisen.
|
||||||
|
Ebenfalls kannst du auswählen, ob du eine Adresse für den Kontakt festlegen willst (wenn nicht mach einfach den Haken bei Adresse weg).
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um einen Kontakt zu bearbeiten kannst du in der Kontaktübersicht den Button `Details` für den gewünschten Kontakt anklicken.
|
||||||
|
In der Übersicht für diesen Kontakt kannst du nun den Namen, die Telefonnummer, die E-Mail Adresse und die Adresse anpassen.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst einen Kontakt entweder aus der Kontaktübersicht oder der Kontaktdetailansicht löschen.
|
||||||
|
> Dabei wird nur der Kontakt gelöscht, keine verbundenen Orgs oder Teams.
|
||||||
|
|
||||||
|
### In der Kontaktübersicht
|
||||||
|
Klick bei dem gewünschten Kontakt auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du den Kontakt wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Kontaktdetailansicht
|
||||||
|
Klick bei dem gewünschten Kontakt auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Kontakt löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du den Kontakt wirklich löschen oder abbrechen willst.
|
55
legacy/src/users/donations.md
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
# Sponsorings
|
||||||
|
|
||||||
|
Sponsorings können entweder Festbetragsspenden oder Kilometerspenden sein.
|
||||||
|
Kilometerspenden verbinden <router-link to="./runners">Läufer:innen</router-link> mit <router-link to="./donors">Sponsor:innen</router-link>, die einen festen Betrag pro zurückgelegtem Kilometer der Läufer:in spenden.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um ein neues Sponsoring anzulegen öffne im Läufersystem die Seite `Sponsorings`.
|
||||||
|
Über den Button `Sponsoring erstellen` kannst du ein neues Sponsoring anlegen.
|
||||||
|
|
||||||
|
Als erstes kannst du auswählen, ob du ein (Kilometer)Sponsoring oder eine Festbetragsspende erstellen möchtest.
|
||||||
|
Dann musst du die Sponsor:in auswählen.
|
||||||
|
|
||||||
|
### Sponsoring (Kilometerspende)
|
||||||
|
Für Kilometerspenden musst du nun eine Läufer:in auswählen und angeben, wie viele Euro die Sponsor:in pro gelaufenem Kilometer der Läufer:in spenden möchte.
|
||||||
|
Sobald du alles angegeben hast kannst du mit dem Button `Erstellen` das Sponsoring anlegen.
|
||||||
|
|
||||||
|
### Festbetragsspende
|
||||||
|
Für Festbetragsspenden musst du nun den Spendenbetrag in Euro angeben.
|
||||||
|
Sobald du alles angegeben hast kannst du mit dem Button `Erstellen` die Festbetragsspende anlegen.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um ein Sponsoring zu bearbeiten kannst du in der Sponsoringübersicht den Button `Details` für das gewünschte Sponsoring anklicken.
|
||||||
|
Hier siehst du den Gesamtbetrag (bei Kilometerspenden hochgerechnet) des Sponsoring und kannst die Sponsor:in ändern.
|
||||||
|
|
||||||
|
### Sponsoring (Kilometerspende)
|
||||||
|
Für Kilometerspenden kannst du zusätzlich die Läufer:in und den Spendenbetrag pro gelaufenem Kilometer anpassen.
|
||||||
|
Sobald du alles angepasst hast kannst du mit dem Button `Änderungen speichern` die Änderungen übernehmen.
|
||||||
|
|
||||||
|
### Festbetragsspende
|
||||||
|
Für Festbetragsspenden kannst du zusätzlich den Spendenbetrag anpassen.
|
||||||
|
Sobald du alles angepasst hast kannst du mit dem Button `Änderungen speichern` die Änderungen übernehmen.
|
||||||
|
|
||||||
|
## Zahlung eingeben
|
||||||
|
### In der Sponsoringübersicht
|
||||||
|
Um eine Zahlung einzugeben kannst du in der Sponsoringübersicht den Button `Zahlung eingeben` für das gewünschte Sponsoring anklicken.
|
||||||
|
|
||||||
|
Daraufhin öffnet sich ein Dialog, in dem du den bezahlten Betrag für das Sponsoring eingeben kannst.
|
||||||
|
Wenn das Sponsoring auf den Cent genau bezahlt wurde kannst du dir das eintippen über den Button `MAX` sparen.
|
||||||
|
|
||||||
|
Wenn du deine Änderungen vorgenommen hast kannst du diese über den Button `Änderungen speichern` übernehmen.
|
||||||
|
|
||||||
|
### Im Sponsoringdetail
|
||||||
|
> Siehe Sponsoring bearbeiten
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst ein Sponsoring entweder aus der Sponsoringübersicht oder der Sponsoringdetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Sponsoringübersicht
|
||||||
|
Klick bei dem gewünschten Sponsoring auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du das Sponsoring wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Sponsoringdetailansicht
|
||||||
|
Klick bei dem gewünschten Sponsoring auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Sponsoring löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du das Sponsoring wirklich löschen oder abbrechen willst.
|
44
legacy/src/users/donors.md
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
# Sponsor:innen
|
||||||
|
|
||||||
|
Sponsor:innen sind die Spender, die mit einen Festbetrag oder eine Kilometerspende den Lauf für Kaya! unterstützen.
|
||||||
|
Zusammen mit den <router-link to="./donations">Sponsorings</router-link> bilden sie das Herzstück des Spendenmanagement und der Spendenverrechnung.
|
||||||
|
|
||||||
|
## Sponsorübersicht
|
||||||
|
> Eine kurze Übersicht über die Funktionen der Sponsorübersicht.
|
||||||
|
|
||||||
|
In der Sponsorübersicht werden alle im System registrierten Sponsor:innen aufgelistet.
|
||||||
|
Von hier aus kannst du einzelne Sponsor:innen hinzufügen, bearbeiten oder löschen.
|
||||||
|
|
||||||
|
Zusätzlich zum Namen und Kontaktinformationen werden hier auch alle Sponsorings (Festbetragsspenden, Kilometerspenden) der Sponsor:in aufgelistet (und verlinkt).
|
||||||
|
Auch der Spendengesamtbetrag aller Sponsorings der Sponsor:in wird hier gelistet.
|
||||||
|
|
||||||
|
Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Sponsornamen und -IDs suchen kannst.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um eine neue Sponsor:in anzulegen öffne im Läufersystem die Seite `Sponsor:innen`.
|
||||||
|
Über den Button `Sponsor:in hinzufügen` kannst du eine neue Sponsor:in anlegen.
|
||||||
|
Dabei musst du einen Vornamen und Nachnamen festlegen.
|
||||||
|
Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben.
|
||||||
|
Sollte die Sponsor:in eine Spendenquittung benötigen kannst du einen Haken bei `Spendenquittung benötigt` setzen und die Adresse der Sponsor:in eintragen.
|
||||||
|
Sobald du alles eingetragen hast kannst du mit dem Button `Erstellen` die Sponsor:in anlegen.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Sponsor:in zu bearbeiten kannst du in der Sponsorübersicht den Button `Details` für die gewünschte Sponsor:in anklicken.
|
||||||
|
In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Adresse(Spendenquittung benötigt) bearbeiten.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst eine Sponsor:in entweder aus der Sponsorübersicht oder der Sponsorendetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Sponsorübersicht
|
||||||
|
Klick bei der gewünschten Sponsor:in auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Sponsor:in wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Sponsorendetailansicht
|
||||||
|
Klick bei der gewünschten Sponsor:in auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Sponsor:in löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Sponsor:in wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### Sponsor:in mit Sponsorings
|
||||||
|
Sollte die Sponsor:in noch Sponsorings haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
|
||||||
|
Hier musst du nochmal die Löschung inklusive aller Sponsorings bestätigen, alternativ kannst du auch Abbrechen.
|
36
legacy/src/users/organizations.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# Organisationen
|
||||||
|
> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu <router-link to="../selfservice/org_selfservice">hier</router-link>
|
||||||
|
|
||||||
|
Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer.
|
||||||
|
Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein.
|
||||||
|
|
||||||
|
Läufer:innen können direkt einer Organisation zugeordnet werden.
|
||||||
|
Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden.
|
||||||
|
Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
|
||||||
|
Mehr zu Teams findest du <router-link to="./teams">hier</router-link>
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`.
|
||||||
|
Über den Button `Organisation erstellen` kannst du eine neue Organisation erstellen.
|
||||||
|
Dabei kannst du der Organisation einen Namen geben.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Organisation zu bearbeiten kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken.
|
||||||
|
In der Übersicht für diese Organisation kannst du nun den Namen der Organisation und den zugewiesenen Kontakt ändern.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst eine Organisation entweder aus der Organisationsübersicht oder der Organisationsdetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Organisationsübersicht
|
||||||
|
Klick bei der gewünschten Organisation auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Organisationsdetailansicht
|
||||||
|
Klick bei der gewünschten Organisation auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Organisation löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### Organisation mit Teams und Läufer
|
||||||
|
Sollte die Organisation noch Teams und/oder Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
|
||||||
|
Hier musst du nochmal die Löschung inklusive aller Läufer und Teams bestätigen, alternativ kannst du auch Abbrechen.
|
109
legacy/src/users/runner_import.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
# Läuferimport
|
||||||
|
|
||||||
|
Um das Eintragen von Läufer:innen ins System zu erleichtern können Läufer aus Excel-Tabellen(CSV, XLSX) importiert werden.
|
||||||
|
Diese Funktion ist vor allem für Schulen und Kindergärten gedacht, kann aber natürlich für alle Arten von Teams und Organisationen verwendet werden.
|
||||||
|
Im Folgenden erklären wir dir Schritt für Schritt, wie du Läufer ins System importieren kannst.
|
||||||
|
|
||||||
|
## Aufbau der Importdateien
|
||||||
|
> Die Datei muss im Format XLSX(Excel) oder CSV vorliegen
|
||||||
|
|
||||||
|
Alle Läufer müssen auf einem "Tabellenblatt"(Excel) stehen, alle weiteren Tabellenblätter werden ignoriert.
|
||||||
|
Die Tabelle muss folgendem Schema folgen:
|
||||||
|
Vorname | Mittelname | Nachname | Team/Klasse
|
||||||
|
- | - | - | -
|
||||||
|
Vorname1 | Optional | Nachname1 | Optional
|
||||||
|
|
||||||
|
Achtung: Die Team Spalte kann Team oder Klasse heißen!
|
||||||
|
|
||||||
|
### Beispiel: CSV
|
||||||
|
|
||||||
|
**Mit Mittelname**
|
||||||
|
> [Beispieldatei herunterladen](/files/class_with_middlename.csv)
|
||||||
|
|
||||||
|
```
|
||||||
|
Vorname; Mittelname; Nachname; Team;
|
||||||
|
Peter; ; Tester; 1A
|
||||||
|
Manuel; Steffen; Regenwald; 1A
|
||||||
|
Toller; ; Typ; 2A
|
||||||
|
```
|
||||||
|
|
||||||
|
**Ohne Mittelname**
|
||||||
|
> [Beispieldatei herunterladen](/files/class_without_middlename.csv)
|
||||||
|
|
||||||
|
```
|
||||||
|
Vorname; Nachname; Team;
|
||||||
|
Peter; Tester; 1A
|
||||||
|
Manuel; Regenwald; 1A
|
||||||
|
Toller; Typ; 2A
|
||||||
|
```
|
||||||
|
|
||||||
|
### Beispiel: XLSX (Excel)
|
||||||
|
**Mit Mittelname**
|
||||||
|
> [Beispieldatei herunterladen](/files/class_with_middlename.xlsx)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
**Ohne Mittelname**
|
||||||
|
> [Beispieldatei herunterladen](/files/class_without_middlename.xlsx)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Import in eine Organisation
|
||||||
|
> Wähle diese Variante, wenn du in einer Organisation automatisch Teams anlegen und die Läufer in diese Importieren willst. <br>
|
||||||
|
> Wähle diese Variante, wenn du Läufer direkt in eine Organisation importieren willst.
|
||||||
|
|
||||||
|
Wenn in der Datei bei einer Läufer:in kein Team angegeben ist wird sie direkt in die Organisation importiert.
|
||||||
|
Ist ein Team angegeben wird das Team in der Organisation gesucht und neu Angelegt, wenn es nicht gefunden wurde - danach wird die Läufer:in in das Team importiert.
|
||||||
|
|
||||||
|
### Aus der Organisationsübersicht
|
||||||
|
1. Öffne im Läufersystem die Seite `Orgs`
|
||||||
|
2. Klicke oben auf `Läufer importieren`
|
||||||
|
3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
|
||||||
|
4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
|
||||||
|
5. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
|
||||||
|
6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
|
||||||
|
7. Die Läufer werden nun in die Organisation importiert
|
||||||
|
|
||||||
|
### Aus der Organisationsdetailansicht
|
||||||
|
1. Öffne im Läufersystem die Seite `Orgs`
|
||||||
|
2. Klicke bei der gewünschten Organisation auf den `Details` Button
|
||||||
|
3. Klicke oben auf `Läufer importieren`
|
||||||
|
4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
|
||||||
|
5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
|
||||||
|
6. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
|
||||||
|
7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
|
||||||
|
8. Die Läufer werden nun in die Organisation importiert
|
||||||
|
|
||||||
|
### Aus der Läuferübersicht
|
||||||
|
1. Öffne im Läufersystem die Seite `Läufer`
|
||||||
|
2. Klicke oben auf `Läufer importieren`
|
||||||
|
3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
|
||||||
|
4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
|
||||||
|
5. Wähle oben die Organisation (Hat kein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
|
||||||
|
6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
|
||||||
|
7. Die Läufer werden nun in die Organisation importiert
|
||||||
|
|
||||||
|
## Import in ein Team
|
||||||
|
> Wähle diese Variante, wenn du Läufer direkt in ein Team importieren willst.
|
||||||
|
|
||||||
|
Wenn in der Datei bei einer Läufer:in ein Team angegeben ist wird dieses ignoriert und mit dem gewählten Team überschrieben..
|
||||||
|
|
||||||
|
### Aus der Teamdetailansicht
|
||||||
|
1. Öffne im Läufersystem die Seite `Teams`
|
||||||
|
2. Klicke bei de, gewünschten Team auf den `Details` Button
|
||||||
|
3. Klicke oben auf `Läufer importieren`
|
||||||
|
4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
|
||||||
|
5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
|
||||||
|
6. Wähle oben das Team aus, in die die Läufer:innen importiert werden sollen
|
||||||
|
7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
|
||||||
|
8. Die Läufer werden nun in das Team importiert
|
||||||
|
|
||||||
|
### Aus der Läuferübersicht
|
||||||
|
1. Öffne im Läufersystem die Seite `Läufer`
|
||||||
|
2. Klicke oben auf `Läufer importieren`
|
||||||
|
3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
|
||||||
|
4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
|
||||||
|
5. Wähle oben das Team (Hat ein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
|
||||||
|
6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
|
||||||
|
7. Die Läufer werden nun in das Team importiert
|
54
legacy/src/users/runners.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Läufer:innen
|
||||||
|
|
||||||
|
Läufer sind das Herzstück des Läufersystems.
|
||||||
|
Über sie werden Strecken erfasst und Spenden berechnet.
|
||||||
|
|
||||||
|
Läufer können einem <router-link to="./teams">Team</router-link> oder einer <router-link to="./organizations">Organisation</router-link> zugeordnet werden.
|
||||||
|
|
||||||
|
## Läuferübersicht
|
||||||
|
> Eine kurze Übersicht über die Funktionen der Läuferübersicht.
|
||||||
|
|
||||||
|
In der Läuferübersicht werden alle im System registrierten Läufer:innen aufgelistet.
|
||||||
|
Von hier aus kannst du einzelne Läufer:innen hinzufügen, bearbeiten oder löschen.
|
||||||
|
|
||||||
|
Um die Suche nach einzelnen Läufer:innen zu erleichtern gibt es einen Filter nach Teams und Organisationen.
|
||||||
|
Wenn du mehrere Teams/Organisationen in den Filter packst werden dir alle Läufer:innen angezeigt, die in einem/r der Teams/Organisationen registriert sind angezeigt.
|
||||||
|
|
||||||
|
Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Läufernamen, -IDs und Gruppen (Teams/Organisationen) suchen kannst.
|
||||||
|
Du eine ID eingibst wird dir nur die Läufer:in mit genau der ID angezeigt, solltest du alle Läufer:innen sehen wollen, deren IDs mit deiner Eingabe beginnen stelle ein `*` ans Ende der ID.
|
||||||
|
|
||||||
|
Beispiele:
|
||||||
|
* `Peter` -> Alle Läufer:innen mit Peter im Namen
|
||||||
|
* `Gymnasium` -> Alle Läufer:innen, die in einer Gruppe mit dem Namen Gymnasium sind
|
||||||
|
* `421` -> Die Läufer:in mit der ID 421
|
||||||
|
* `42*` -> Alle Läufer:innen, deren ID mit 42 beginnt
|
||||||
|
|
||||||
|
## Aktionen
|
||||||
|
|
||||||
|
### Anlegen
|
||||||
|
> Achtung: Um eine Läufer:in anzulegen musst du vorher eine Organisation und/oder ein Team anlegen.
|
||||||
|
|
||||||
|
Um eine neue Läufer:in anzulegen öffne im Läufersystem die Seite `Läufer`.
|
||||||
|
Über den Button `Läufer:in hinzufügen` kannst du eine neue Läufer:in anlegen.
|
||||||
|
Dabei musst du einen Vornamen, Nachnamen und die Gruppe (Team/Organisation) festlegen.
|
||||||
|
Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben.
|
||||||
|
|
||||||
|
### Bearbeiten
|
||||||
|
Um eine Läufer:in zu bearbeiten kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken.
|
||||||
|
In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Gruppe bearbeiten.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
### Löschen
|
||||||
|
> Du kannst eine Läufer:in entweder aus der Läuferübersicht oder der Läuferdetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Läuferübersicht
|
||||||
|
Klick bei der gewünschten Läufer:in auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Läuferdetailansicht
|
||||||
|
Klick bei der gewünschten Läufer:in auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
## Import
|
||||||
|
> Die Importanleitung findest du <router-link to="./runner_import">hier</router-link>
|
42
legacy/src/users/scans.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# Scans
|
||||||
|
|
||||||
|
Scans sind das Herzstück der Kilometerzählung - sie verbinden <router-link to="./runners">Läufer:innen</router-link> mit zurückgeleter Distantz.
|
||||||
|
Es gibt zwei Arten von Scans im System: "Festdistanzscans" und "Trackscans"
|
||||||
|
|
||||||
|
Festdistanzscans können nur von Benutzer:innen im Läufersystem angelegt werden und weisen einer Läufer:in eine feste Distanz zu.
|
||||||
|
Dies ist besonders nützlich, wenn Läufer:innen Karten auf halber Strecke verloren haben oder aus anderen Gründen einen Distanzbonus bekommen.
|
||||||
|
|
||||||
|
Trackscans hingegen können nur dadurch erzeugt werden, dass eine Scannerstation den Code der Karte einer Läufer:in scannen und so einen neuen Scan anlegen.
|
||||||
|
Die Trackscans sind immer Fest mit einer Läufer:in und einem <router-link to="./tracks">Track</router-link> verbunden, von dem die Distanz abgeleitet wird.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
> Du kannst im Läufersystem nur Festdistanzscans anlegen.
|
||||||
|
|
||||||
|
Um einen neue Scan anzulegen öffne im Läufersystem die Seite `Scans`.
|
||||||
|
Über den Button `Scan erstellen` kannst du einen neuen Scan erstellen.
|
||||||
|
Dabei musst du dem Scan eine Läufer:in und eine Distanz in Metern zuweisen.
|
||||||
|
Sobald du alles angegeben hast kannst du über den Button `Erstellen` den Scan anlegen.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um einen Scan zu bearbeiten kannst du in der Scansübersicht den Button `Details` für den gewünschten Scananklicken.
|
||||||
|
|
||||||
|
### Festdistanzscans
|
||||||
|
Bei Festdistanzscans kannst du in der Scandetailansicht die Gültigkeit, Läufer:in und Distanz anpassen.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
### Trackscans
|
||||||
|
Bei Trackscans kannst du in der Scandetailansicht nur die Gültigkeit anpassen - alle anderen Werte sind fest im System hinterlegt.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst einen Scan entweder aus der Scansübersicht oder der Scandetailansicht löschen.
|
||||||
|
> Wir empfehlen grundsätzlich Scans lieber zu deaktiveren, als zu löschen, um menschlichen Fehlern vorzubeugen.
|
||||||
|
|
||||||
|
### In der Scansübersicht
|
||||||
|
Klick bei dem gewünschten Scan auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du den Scan wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Scandetailansicht
|
||||||
|
Klick bei dem gewünschten Scannerstation auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Scan löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du den Scannerstation wirklich löschen oder abbrechen willst.
|
44
legacy/src/users/scanstations.md
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
# Scannerstationen
|
||||||
|
> Die Doku zur Nutzung der <router-link to="../scanstations">Scannerstationen gibt es hier</router-link>
|
||||||
|
|
||||||
|
Scannerstationen sind erstellen Scans für Läuferkarten auf <router-link to="./tracks">Tracks</router-link>.
|
||||||
|
Die Scannerstationen sind in realen Welt üblicherweise Laptops mit Barcode-Scannern und einer speziellen Software.
|
||||||
|
|
||||||
|
Die Scannerstationen im Läufersystem dienen dazu die "realen" Scannerstationen anzumelden und einem Track zuzuweisen.
|
||||||
|
Dieser Teil der Dokumentation befasst sich nur mit den Scannerstationen im Läufersystem!
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
> Bevor du eine Scannerstation anlegen kannst musst du erst einen <router-link to="./tracks">Track</router-link> anlegen, zu dem sie gehört.
|
||||||
|
> Du bekommst beim Erstellen einer Scanenrstation einen Token (Code/Key) für diese - bewahre ihn gut auf!
|
||||||
|
|
||||||
|
Um eine neue Scannerstation anzulegen öffne im Läufersystem die Seite `Scannerstationen`.
|
||||||
|
Über den Button `Station erstellen` kannst du eine neue Scanerstation erstellen.
|
||||||
|
Dabei musst du die Station einem Track zuweisen und kannst du der Station eine Beschreibung geben und sie deaktiveren.
|
||||||
|
Wenn du fertig bist kannst du einfach auf den Button `Erstellen` klicken.
|
||||||
|
|
||||||
|
Nachdem die Scannerstation im System erstellt wurde bekommst du ihren Token angezeigt.
|
||||||
|
Dieser Token wird nur einmal angezeigt und kann nicht geändert werden - bewahre ihn also gut auf!
|
||||||
|
Du kannst auf den Token oder den kopieren Button klicken, um den Token in deine Zwischenablage zu kopieren.
|
||||||
|
Wenn du den Token sicher gespeichert hast kannst du den Dialog über den Button `Ja, ich habe den Token kopiert` schließen.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um eine Scannerstation zu bearbeiten kannst du in der Scannerstationsübersicht den Button `Details` für die gewünschte Scannerstation anklicken.
|
||||||
|
In der Übersicht für diese Scannerstation kannst du nun den Track und die Beschreibung der Scannerstation ändern und sie (de)aktivieren.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst eine Scannerstation entweder aus der Scannerstationsübersicht oder der Scannerstationsdetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Scannerstationsübersicht
|
||||||
|
Klick bei der gewünschten Scannerstation auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Scannerstationsdetailansicht
|
||||||
|
Klick bei der gewünschten Scannerstation auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Station löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du die Scannerstation wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### Scannerstation mit Scans
|
||||||
|
> Achtung: Wir empfehlen Stationen mit Scans nie zu löschen sondern einfach zu deaktivieren!
|
||||||
|
Sollte die Scannerstation noch assoziierte Scans haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
|
||||||
|
Hier musst du nochmal die Löschung inklusive aller Scans bestätigen, alternativ kannst du auch Abbrechen.
|
38
legacy/src/users/sponsoring_contracts.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
# Sponsoring-Erklärungen
|
||||||
|
|
||||||
|
Das System kann für beliebige <router-link to="./runners">Läufer:innen</router-link>, <router-link to="./teams">Teams</router-link> oder ganze <router-link to="./organizations">Organisationen</router-link> Sponsoring-Erklärungen generieren.
|
||||||
|
Die Sponsoring-Erklärungen sind dabei aktuell auf Deutsch und Englisch verfügbar.
|
||||||
|
Die Texte auf dem Sponsoring-Erklärungen und die Anzahl von Erklärungen/Läufer:in können deine Admins anpassen.
|
||||||
|
|
||||||
|
## Für Läufer:innen
|
||||||
|
|
||||||
|
### Für Läufer:innen in der Läuferübersicht
|
||||||
|
In der Läuferübersicht kannst du beliebig viele Läufer:innen auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Läuferliste der Button `Sponsoringvertrag generieren`.
|
||||||
|
Sobald du ihn anklickst werden die Sponsoring-Erklärungen generiert und heruntergeladen.
|
||||||
|
|
||||||
|
### Für einzelne Läufer:in in der Läuferdetailansicht
|
||||||
|
Um eine Sponsoring-Erklärung für eine einzelne Läufer:in zu generieren kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken.
|
||||||
|
Dann kannst du auf der Detailansicht einfach den Button `Sponsoringvertrag generieren` anklicken - daraufhin wird die Sponsoring-Erklärung generiert und heruntergeladen.
|
||||||
|
|
||||||
|
## Für Teams
|
||||||
|
|
||||||
|
### Für Teams in der Teamübersicht
|
||||||
|
In der Teamübersicht kannst du beliebig viele Teams auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Teamliste der Button `Sponsoringverträge generieren`.
|
||||||
|
Sobald du ihn anklickst werden die Sponsoring-Erklärungen für alle Läufer:innen der Teams generiert und heruntergeladen.
|
||||||
|
|
||||||
|
### Für einzelne Teams in der Teamdetailansicht
|
||||||
|
Um Sponsoring-Erklärungen für alle Läufer:innen eines einzelne Teams zu generieren kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken.
|
||||||
|
Dann kannst du auf der Detailansicht einfach den Button `Sponsoringverträge generieren` anklicken - daraufhin werden die Sponsoring-Erklärungen generiert und heruntergeladen.
|
||||||
|
|
||||||
|
## Für Organisationen
|
||||||
|
|
||||||
|
### Für Organisationen in der Organisationsübersicht
|
||||||
|
In der Organisationsübersicht kannst du beliebig viele Organisationen auswählen (oder alle über den Button `Alle Auswählen`).
|
||||||
|
Daraufhin erscheint über der Organisationsliste der Button `Sponsoringverträge generieren`.
|
||||||
|
Sobald du ihn anklickst werden die Sponsoring-Erklärungen für alle Läufer:innen der Organisationen (inklusive ihrer Teams) generiert und heruntergeladen.
|
||||||
|
|
||||||
|
### Für einzelne Organisationen in der Teamdetailansicht
|
||||||
|
Um Sponsoring-Erklärungen für alle Läufer:innen einer einzelnen Organisation (inklusive ihrer Teams) zu generieren kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken.
|
||||||
|
Dann kannst du auf der Detailansicht einfach den Button `Sponsoringverträge generieren` anklicken - daraufhin werden die Sponsoring-Erklärungen generiert und heruntergeladen.
|
35
legacy/src/users/teams.md
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
# Teams
|
||||||
|
|
||||||
|
Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen.
|
||||||
|
Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein.
|
||||||
|
|
||||||
|
Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du <router-link to="./organizations">hier</router-link>).
|
||||||
|
Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
> Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen.
|
||||||
|
|
||||||
|
Um ein neues Team anzulegen öffne im Läufersystem die Seite `Teams`.
|
||||||
|
Über den Button `Team erstellen` kannst du ein neues Team erstellen.
|
||||||
|
Dabei kannst du dem Team einen Namen geben und auswählen, zu welcher Organisation das Team gehört.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um ein Team zu bearbeiten kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken.
|
||||||
|
In der Übersicht für dieses Team kannst du nun den Namen, die Mutter-Organisation und den Kontakt des Teams ändern.
|
||||||
|
Wenn du fertig bist klick einfach auf `Änderungen speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
> Du kannst ein Team entweder aus der Teamübersicht oder der Teamdetailansicht löschen.
|
||||||
|
|
||||||
|
### In der Teamübersicht
|
||||||
|
Klick bei dem gewünschten Team auf den Button `Löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### In der Teamdetailansicht
|
||||||
|
Klick bei dem gewünschten Team auf den Button `Details`.
|
||||||
|
Oben auf der Seite gibt es jetzt den Knopf `Team löschen`.
|
||||||
|
Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
|
||||||
|
|
||||||
|
### Teams mit Läufern
|
||||||
|
Sollte das Team noch Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
|
||||||
|
Hier musst du nochmal die Löschung inklusive aller Läufer bestätigen, alternativ kannst du auch Abbrechen.
|
19
legacy/src/users/tracks.md
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# Tracks
|
||||||
|
|
||||||
|
Die Tracks sind im System hinterlegte Laufstrecken, auf basis derer die Distanzen für Scans berechnet werden.
|
||||||
|
Sie haben einen Namen, eine Distanz (in Metern) und eine minimale Rundenzeit (Schnellere Runden werdena utomatisch als Betrug gekennzeichnet).
|
||||||
|
Beim Lauf für Kaya! gab es in der Vergangenheit immer die zwei Tracks "kleine Runde" (400m) und "große Runde" (1000m).
|
||||||
|
|
||||||
|
## Anlegen
|
||||||
|
Um einen neuen Track anzulegen öffne im Läufersystem die Seite `Tracks`.
|
||||||
|
Über den Button `Track erstellen` kannst du einen neuen Track erstellen.
|
||||||
|
Dabei musst du den Namen des Tracks und seine Länge in Metern angeben - optional kannst du noch eine minimale Rundenzeit in Sekunden angeben.
|
||||||
|
|
||||||
|
## Bearbeiten
|
||||||
|
Um einen Track zu bearbeiten kannst du in der Trackübersicht den Button `Bearbeiten` für den gewünschten Track anklicken.
|
||||||
|
Daraufhin kannst du die Werte der Spalte des Tracks bearbeiten.
|
||||||
|
Wenn du fertig bist klick einfach auf `Speichern`.
|
||||||
|
|
||||||
|
## Löschen
|
||||||
|
Um einen Track zu bearbeiten kannst du in der Trackübersicht den Button `Löschen` für den gewünschten Track anklicken.
|
||||||
|
Daraufhin hast du die möglichkeit den Löschvorgang abzubrechen oder mit einem Klick auf `Bestätigen` den Track entgültig zu löschen.
|