ModelUI is a cross-platform desktop application boilerplate built using the Avalonia framework in C#. It aims to provide a solid starting point for building clean, modern desktop apps with ease.

This project integrates the free version of the Actipro Avalonia Controls to deliver elegant UI components and interactions.

⚠️ The original Actipro demo contains a lot of sample code. This repo distills it into a minimal working base for real-world applications.

• ✅ Side Navigation Bar
• ✅ Smooth Transitions Between Views
• ✅ Designed for Non-MVVM Architecture
• ✅ Day & Night Theme Support
• ✅ Cross-Platform (Windows & Linux – even Raspberry Pi!)
• ✅ Lightweight Release Output
• ✅ Built-in Configuration File Read/Write
• ✅ Boilerplate Database Module for Info Storage

• Refactor and improve code structure
• Fix view transition overlap (Sidebar currently overlaps second view)
• Accepting contributions! Feel free to fork and send a PR

• ✅ Windows (10 and above)
• ✅ Linux (Tested on Ubuntu, Linux Mint, Raspberry Pi OS, etc.)

You can build and publish the app as a self-contained executable using Avalonia. This includes the framework and works well on both platforms. Be sure to enable the "Produce single file" option in your release configuration.

If you want to create your own app based on this boilerplate:

1. Fork the repository.
2. Run the RenameProject.bat or RenameProject.sh script (Windows or Linux).
3. Enter your new project name when prompted.

This will update solution files and namespaces automatically.

The included BackupData.bat script can help you archive your project:

• Edit the following line to specify a backup path:

  set BackupLocation="E:\Backups\"

• When run, it creates a .7z archive with a timestamp.

Requires 7-Zip. Currently works on Windows only.

• I previously used SukiUI, which is a great UI toolkit. However, I found Actipro's Avalonia controls more stable and elegant for my needs, especially with recent breaking changes in SukiUI (No offense to the dev — great work there!).

Replace local paths with actual GitHub-relative paths or URLs for images to display correctly.

ModelUI in Action:

Release Configuration Example:

Pull requests and contributions are welcome! If you find a bug or have a feature request, feel free to open an issue.

This project is open-source and available under the MIT License.