Skip to content

An open-source tournament planning application for football clubs

License

Notifications You must be signed in to change notification settings

turnierplan-NET/turnierplan.NET

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

217 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

turnierplan.NET

An open-source tournament planning application for football clubs

.github/workflows/validate.yaml Code Smells Bugs Lines of Code Coverage NuGet Version

Introduction

turnierplan.NET is mostly written in C# using .NET. 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 framework. Some screenshots can be seen in the section at the end.

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.

Documentation

Visit the turnierplan.NET documentation using the following link: docs.turnierplan.net

The documentation sources are located in the docs directory. See the docs readme for further information on how to edit and build the documentation.

Development

This section describes how to set up the development environment. First, you need to install the following tools installed on your machine:

To run the application from source, follow these steps:

  1. Open the src/Turnierplan.slnx solution.
  2. Run the Turnierplan.AppHost project. Make sure to use the configuration with client. This will start the Aspire AppHost which will do the following steps:
    • Download the postgres container image and run a local database
    • Install npm dependencies and run the client app
    • Run the backend Turnierplan.App
  3. The Aspire dashboard will open up from which you can navigate to the client application (http://localhost:45001).
  4. Now you can log in using default credentials: The username is admin and the password is P@ssw0rd.

When running locally, the API documentation can be viewed by opening http://localhost:45000/scalar.