Darp.Templates 1.7.0

Avalonia ExampleProject

This repository contains an example project which can be used to base new projects on.

Features

• Already configured repository
  • GitHub actions workflows
  • editorconfig and .gitignore setup
  • CPM
  • .slnx solution files
  • CSharpier as a code formatter
• Platform independent
  • Build for any desktop platform
  • Easily extensible to mobile platforms
• High performant
  • PublishAot and trimming is enabled by default
  • SplashScreen for resource loading on startup
• Personalization by default
  • Runtime switching of themes
  • Runtime switching of languages (using .resx and source generation)
• Feature-oriented MVVM structure
  • Feature-specific views, view models, and registrations live together
  • Route-based shell navigation keeps navigation UI independent from concrete view model types
• WinUI3 styling
  • Usage of FluentAvalonia for WinUI3 styles and controls
• Industry tested
  • Desktop applications used in the Industry were build with the same technologies
• Opinionated toolset
  • Microsoft Dependency Injection for DI
  • Serilog for Logging
  • CommunityToolkit.Mvvm for ObservableProperties and Commands
  • Darp.Utils.Dialog for MVVM compatible dialogs
  • System.Text.Json with source generation for configuration files

Project structure

The app is organized by feature first, with a small set of app-wide folders:

src/AvaloniaExampleProject/
  Assets/    Global assets and localization resources
  Features/  User-facing feature slices
  Services/  App-wide services and runtime capabilities
  Shell/     Main window, app shell, and design-time support
  Styling/   Global Avalonia styling resources

Feature-specific UI, view models, and registrations live together under Features/<FeatureName>/. App-wide capabilities such as theming, logging, storage access, and navigation live under Services/.

Preview

How to use this project as a template

Install the rosslight templates nuget package:

dotnet new install Darp.Templates 

Then, create a new template using

dotnet new darp.avalonia.desktop -o MyApp

GitHub Actions

• Go to the workflow file

Further reading

As stated, this is a opinionated app. Take a look at other resources

• Awesome Avalonia
• Avalonia docs
• Modern.Net-Tutorial

About

This is a project by rosslight GmbH