StarterApp

The purpose of this app is to act as a starting point for further development. It provides some basic features including:

Database integration and migrations
Role-based security
Local authentication
Example navigation

This version of the app uses PostgreSQL for data storage and Entity Framework Core for object-relational mapping and migrations.

To fully understand how it works, you should follow an appropriate set of tutorials such as this one which covers all of the main concepts and techniques used here. However, if you want to jump straight in and work out any problems as you go along, that will also work. The code uses structured comments for use with the Doxygen documentation generator tool.

You can use any development environment with this project including

The instructions assume you will be using VSCode since that is a lowest-common-denominator choice.

Compatibility

This app is built using the following tool versions.

Name	Version
.NET	8.0 / 9.0
PostgreSQL Docker image	16

Getting started

Prerequisites

Before using this app, ensure you have:

.NET SDK 8.0 or later installed
Docker installed and running
PostgreSQL container running (see dev-environment tutorial)

Configuration

Copy StarterApp.Database/appsettings.json.template to StarterApp.Database/appsettings.json

Update the connection string with your PostgreSQL credentials:

{
  "ConnectionStrings": {
    "DevelopmentConnection": "Host=localhost;Username=student_user;Password=password123;Database=starterapp"
  }
}

Initial Setup

Navigate to the Migrations project and create the initial migration:

cd StarterApp.Migrations
dotnet ef migrations add InitialCreate

Apply the migration to create the database:

dotnet ef database update

Build and run the application:

cd ../StarterApp
dotnet build
dotnet run

Tutorial

For a comprehensive guide on using this app and understanding its architecture, see the MAUI + MVVM + Database Tutorial.