diff --git a/README.md b/README.md index bb33517d..19d240fe 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,13 @@ ## 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. +**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). This readme describes how to deploy the application using the pre-built containers or how to get a local development environment up and running. +> [!NOTE] +> The user interface is currently only available in German 🇩🇪 + ## Deployment **turnierplan.NET** comes as a pre-built container image which can be deployed with minimal configuration. The image is available on GitHub: [ghcr.io/turnierplan-net/turnierplan](https://github.com/turnierplan-NET/turnierplan.NET/pkgs/container/turnierplan) @@ -115,6 +118,19 @@ To run the application from source, follow these steps: When running locally, the API documentation can be viewed by opening [http://localhost:45000/scalar](http://localhost:45000/scalar). +## Screenshots + +Below are some screenshots of the application: + +1. *Creating a new tournament:* + ![Screenshot that shows the create tournament page](images/create-tournament.png) +2. *Exporting a tournament to PDF document:* + ![Screenshot that shows the PDF export page](images/export-pdf.png) +3. *Viewing a timetable of multiple tournaments:* + ![Screenshot that shows the folder timetable page](images/folder-timetable.png) +4. *Reporting the outcome of a match:* + ![Screenshow that shows the match reporting dialog](images/report-match.png) + ## Turnierplan.Adapter If you want to use the **turnierplan.NET** API programatically in a .NET environment, you can use the `Turnierplan.Adapter` [package](https://www.nuget.org/packages/Turnierplan.Adapter) which contains all model classes and an abstraction layer to easily query the API endpoints. diff --git a/images/create-tournament.png b/images/create-tournament.png new file mode 100644 index 00000000..ead43262 Binary files /dev/null and b/images/create-tournament.png differ diff --git a/images/export-pdf.png b/images/export-pdf.png new file mode 100644 index 00000000..551917a8 Binary files /dev/null and b/images/export-pdf.png differ diff --git a/images/folder-timetable.png b/images/folder-timetable.png new file mode 100644 index 00000000..758d29be Binary files /dev/null and b/images/folder-timetable.png differ diff --git a/images/report-match.png b/images/report-match.png new file mode 100644 index 00000000..072717e8 Binary files /dev/null and b/images/report-match.png differ