This is the backend for an upcoming .NET MAUI
application for visualizing the current state (UP, DOWN, response time, etc.) of a web application or service.
This service was created as part of a university project during my masters degree in computer science. It serves as the needed backend for a .NET MAUI
application, visualizing the provided information. I don't really know if this repository will be updated frequently after finishing the university project. However I have personal interest in adding new features to the backend, e.g. adding notification via e-mail when a service is unreachable.
To be able to run the application the following components need to be installed:
After installing the needed components and cloning this repository, close to everything is ready to go. To run the app please follow these steps:
appsettings.Development.json
to the root of this repositoryappsettings.json
and set the LogLevel
to Debug
docker run --name postgres -e POSTGRES_PASSWORD=root -e POSTGRES_DB=statusapp -d --network=host postgres
appsettings.Development.json
appsettings.Development.json
create an JSON-object named AppSettings
Secret
which will be used as the secret for created JWTsIsDevelopment
and set it to truedotnet ef database update
dotnet run
After following these steps everything should work just fine. However if you have any issues, feel free to reach out.
On the initial launch of the application a token should be printed on the console. This token can be used to create the first user/admin of the application. This process is mandatory to be able to configure the service to query other web applications or services. When opening up the browser and navigating to https://localhost:5001/swagger you will be presented with the OpenAPI
specification of this service. In there you will find all resources exposed by this service and the needed routes to configure querying for other services.
As this is a small project, contributing is fairly simple, but I still want to follow certain steps to keep everything transparent:
master
branch where you will work on the issue following the naming convention: {bug | feature}/{issue-id}_{issue-title}