Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -89,22 +89,22 @@ jobs:
id-token: write
steps:
- uses: actions/checkout@v5
- name: "Set up Python 3.12"
- name: "Set up Python 3.x"
uses: actions/setup-python@v5
with:
python-version: "3.12"
python-version: "3.x"
- name: "Install requirements"
run: "python3 -m pip install -r requirements.txt"
working-directory: "docs"
- name: "Build documentation"
run: "python3 -m mkdocs build"
run: "zensical build --clean"
working-directory: "docs"
- name: "Setup Pages"
uses: actions/configure-pages@v5
- name: Upload artifact
- name: "Upload artifact"
uses: actions/upload-pages-artifact@v3
with:
path: "docs/site"
- name: Deploy to GitHub Pages
- name: "Deploy to GitHub Pages"
id: deployment
uses: actions/deploy-pages@v4
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ jobs:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v5
- name: "Set up Python 3.12"
- name: "Set up Python 3.x"
uses: actions/setup-python@v5
with:
python-version: "3.12"
python-version: "3.x"
- name: "Install requirements"
run: "python3 -m pip install -r requirements.txt"
working-directory: "docs"
- name: "Build documentation"
run: "python3 -m mkdocs build"
run: "zensical build --clean"
working-directory: "docs"
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,12 @@

## Introduction

**turnierplan.NET** is mostly written in C# using [.NET](https://dotnet.microsoft.com/). This includes the core logic, the backend API and database connection as well as all publicly visible web pages. In addition, it serves the *turnierplan.NET portal*, the client application for authenticated users, based on the [Angular](https://angular.dev/) framework. Some screenshots can be seen in the [section at the end](#screenshots).
**turnierplan.NET** is mostly written in C# using [.NET](https://dotnet.microsoft.com/). This includes the core logic, the backend API and database connection as well as all publicly visible web pages. In addition, it serves the *turnierplan.NET portal*, the client application for authenticated users, based on the [Angular](https://angular.dev/) framework.

> [!NOTE]
> The user interface is currently only available in German 🇩🇪

## Installation

If you want to install **turnierplan.NET** on your server, please visit the [Installation guide](https://docs.turnierplan.net/installation).
Visit the **turnierplan.NET** documentation using the following link: [docs.turnierplan.net](https://docs.turnierplan.net). If you want to install **turnierplan.NET** on your server, please visit the [Installation guide](https://docs.turnierplan.net/installation).

## Documentation

Visit the **turnierplan.NET** documentation using the following link: [docs.turnierplan.net](https://docs.turnierplan.net)

The documentation sources are located in the `docs` directory. See the [docs readme](docs/README.md) for further information on how to edit and build the documentation.
> [!NOTE]
> The user interface and documentation are currently only available in German 🇩🇪

## Development

Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## turnierplan.NET · Documentation

This directory contains the source markdown files and mkdocs configuration for the publically available turnierplan.NET documentation: [https://docs.turnierplan.net](https://docs.turnierplan.net).
This directory contains the turnierplan.NET documentation. The content files use an extended markdown format and are build into static HTML using [zensical](https://zensical.org). The documentation is hosted at [docs.turnierplan.net](https://docs.turnierplan.net).

In order to build the documentation locally, you must first install Python and [mkdocs](https://www.mkdocs.org):
In order to build the documentation locally, you must first install Python and `zensical`:

```
pip install -r requirements.txt
```

Next, you can either view the rendered documentation using the mkdocs-build-in server or you can generate the static website files:
Next, you can either view the rendered documentation using the zensical built-in server or you can generate the static website files:

```
python3 -m mkdocs serve # starts a local web server on port 8000
python3 -m mkdocs build # generates static web site artifacts into the 'site' directory
python3 -m zensical serve # starts a local web server on port 8000
python3 -m zensical build # generates static web site artifacts into the 'site' directory
```
32 changes: 0 additions & 32 deletions docs/mkdocs.yml

This file was deleted.

46 changes: 0 additions & 46 deletions docs/pages/assets/turnierplan.css

This file was deleted.

7 changes: 7 additions & 0 deletions docs/pages/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
icon: lucide/wrench
---

# Konfiguration

Anleitung für Konfiguration
7 changes: 7 additions & 0 deletions docs/pages/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
icon: lucide/rocket
---

# Erste Schritte

Anleitung für Erste Schritte
File renamed without changes.
Binary file added docs/pages/images/logo-64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/pages/img/logo-192.png
Binary file not shown.
29 changes: 22 additions & 7 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# turnierplan.NET
---
icon: lucide/house
---

**turnierplan.NET** ist a free and open-source web application for football tournaments
# Startseite

<div class="text-center">
<img src="img/logo-192.png" />
turnierplan.NET ist eine **Open-Source Webanwendung zur Organisation von Turnieren** in Fußballvereinen ([GitHub](https://github.com/turnierplan-NET/turnierplan.NET)).

<div style="margin-top: 2em;" class="grid cards" markdown>
- :lucide-land-plot: Flexible Spielpläne
- :lucide-shield-user: Benutzerverwaltung
- :lucide-globe: Öffentliche Ansicht für Besucher
- :lucide-file-text: Export von PDF-Dokumenten
- :lucide-settings: Zahlreiche Konfigurationsmöglichkeiten
- :lucide-mail: Verwaltung von Turnieranmeldungen
</div>

<hr class="my-5" />
## Made in Germany

turnierplan.NET wird hauptsächlich von Fußballfreunden aus dem nordöstlichen Baden-Württemberg, Deutschland verwendet und maintained 🇩🇪.

Aus diesem Grund sind die Benutzeroberfläche sowie die Dokumentation aktuell ausschließlich in deutscher Sprache verfügbar. Zudem sind die verwendeten Begriffe und Funktionen speziell für die hierzulande üblichen Turniere und Veranstaltungen ausgelegt. Verbesserungsvorschläge sind jederzeit gerne gesehen und können im [Repo](https://github.com/turnierplan-NET/turnierplan.NET) hinterlassen werden.

Falls turnierplan.NET dennoch für deinen Verein / deine Organisation infrage kommt: Der Quelltext und die Container-Images sind unter der [AGPL-3.0](https://github.com/turnierplan-NET/turnierplan.NET/blob/main/LICENSE) lizenziert und dementsprechend frei verwendbar. Mögliche Vorgehensweisen zum Erstellen eines eigenen Setups sind in der [Installationsanleitung](installation.md) beschrieben.

## Getting Started
## Technische Dokumentation

To set up an instance of **turnierplan.NET** on your own server, visit the [Installation](installation.md) guide.
Der Großteil der Anwendung ist in C# geschrieben und basiert auf dem [ASP.NET Core](https://dotnet.microsoft.com/en-us/apps/aspnet) Framework. Die primäre Datenbank, welche von turnierplan.NET verwendet wird, ist [PostgreSQL](https://www.postgresql.org/). Bilddateien werden außerhalb der Datenbank als lokale Dateien oder in einem cloud-basierten Blob-Storage gespeichert. Sämtliche administrative Aufgaben wie das Anlegen von Nutzern oder das Planen und Durchführen von Turnieren werden mit dem turnierplan.NET *Portal* erledigt. Dies ist eine [SPA](https://de.wikipedia.org/wiki/Single-Page-Webanwendung) basierend auf dem [Angular](https://angular.dev/) Framework. Öffentlich sichtbare HTML-Seiten werden allerdings direkt von der ASP.NET-Anwendung gerendert und bereitgestellt.
Loading
Loading