diff --git a/.gitignore b/.gitignore index e5cbb64..795777b 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,35 @@ google-services.json # Android Profiling *.hprof + +# .NET build outputs +bin/ +obj/ + +# Visual Studio / Rider +.vs/ +.idea/ +*.user +*.suo +*.userprefs +*.sln.docstates + +# Build results +[Dd]ebug/ +[Rr]elease/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ + +# Visual Studio cache/options +.vs/ +.vscode/ +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates diff --git a/App.axaml b/App.axaml new file mode 100644 index 0000000..8138784 --- /dev/null +++ b/App.axaml @@ -0,0 +1,15 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/App.axaml.cs b/App.axaml.cs new file mode 100644 index 0000000..b40f4e5 --- /dev/null +++ b/App.axaml.cs @@ -0,0 +1,47 @@ +using Avalonia; +using Avalonia.Controls.ApplicationLifetimes; +using Avalonia.Data.Core; +using Avalonia.Data.Core.Plugins; +using System.Linq; +using Avalonia.Markup.Xaml; +using BackSafe.ViewModels; +using BackSafe.Views; + +namespace BackSafe; + +public partial class App : Application +{ + public override void Initialize() + { + AvaloniaXamlLoader.Load(this); + } + + public override void OnFrameworkInitializationCompleted() + { + if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop) + { + // Avoid duplicate validations from both Avalonia and the CommunityToolkit. + // More info: https://docs.avaloniaui.net/docs/guides/development-guides/data-validation#manage-validationplugins + DisableAvaloniaDataAnnotationValidation(); + desktop.MainWindow = new MainWindow + { + DataContext = new MainWindowViewModel(), + }; + } + + base.OnFrameworkInitializationCompleted(); + } + + private void DisableAvaloniaDataAnnotationValidation() + { + // Get an array of plugins to remove + var dataValidationPluginsToRemove = + BindingPlugins.DataValidators.OfType().ToArray(); + + // remove each entry found + foreach (var plugin in dataValidationPluginsToRemove) + { + BindingPlugins.DataValidators.Remove(plugin); + } + } +} \ No newline at end of file diff --git a/Assets/avalonia-logo.ico b/Assets/avalonia-logo.ico new file mode 100644 index 0000000..f7da8bb Binary files /dev/null and b/Assets/avalonia-logo.ico differ diff --git a/BackSafe.csproj b/BackSafe.csproj new file mode 100644 index 0000000..81ddcad --- /dev/null +++ b/BackSafe.csproj @@ -0,0 +1,29 @@ + + + WinExe + net8.0 + enable + true + app.manifest + true + + + + + + + + + + + + + + + + None + All + + + + diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..3173843 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,58 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +BackSafe is a cross-platform desktop application for backing up data from mobile phones (primarily Android, with photos/videos support on iOS/iPadOS) using a user-provided API key. Built with Avalonia UI and .NET 8, targeting Windows, macOS, and Linux. + +## Development Commands + +### Build and Run +```bash +dotnet build # Build the project +dotnet run # Run the application +dotnet build -c Release # Build for release +``` + +### Debugging +- Avalonia diagnostics are enabled in Debug builds only (BackSafe.csproj:22-25) +- Use F12 or Ctrl+F12 within the running application to access DevTools in Debug mode + +## Architecture + +### UI Framework: Avalonia UI +- Uses AXAML (Avalonia XAML) for UI definitions +- Fluent theme is the default (App.axaml:13) +- Compiled bindings enabled by default (BackSafe.csproj:8) + +### MVVM Pattern +- **ViewModels**: Inherit from `ViewModelBase` (extends `ObservableObject` from CommunityToolkit.Mvvm) +- **Views**: Located in `Views/` directory, defined with `.axaml` files and code-behind `.axaml.cs` +- **ViewLocator**: Automatically maps ViewModels to Views by naming convention (ViewModel → View) + - Example: `MainWindowViewModel` → `MainWindow` + - Implementation in ViewLocator.cs:16 + +### Application Entry Point +- `Program.cs`: Standard .NET entry point + - Configures Avalonia with platform detection, Inter font, and trace logging +- `App.axaml.cs`: Avalonia initialization + - Disables Avalonia's DataAnnotation validation to avoid conflicts with CommunityToolkit (App.axaml.cs:35-46) + - Sets MainWindow with MainWindowViewModel as DataContext + +### Key Dependencies +- **Avalonia 11.3.6**: Cross-platform UI framework +- **CommunityToolkit.Mvvm 8.2.1**: MVVM helpers (ObservableObject, commands, etc.) +- **Avalonia.Fonts.Inter**: Default font package + +### Project Structure +- `ViewModels/`: Contains all ViewModel classes +- `Views/`: Contains AXAML view definitions and code-behind +- `Models/`: Placeholder directory for data models +- `Assets/`: Application resources (icons, etc.) +- `app.manifest`: Windows application manifest + +## MVVM Conventions +- ViewModels use partial classes to support MVVM Toolkit source generators +- Properties in ViewModels should use `[ObservableProperty]` attribute for automatic INotifyPropertyChanged implementation +- Views use `x:DataType` for compiled bindings (see MainWindow.axaml:8) diff --git a/Program.cs b/Program.cs new file mode 100644 index 0000000..7951d3b --- /dev/null +++ b/Program.cs @@ -0,0 +1,21 @@ +using Avalonia; +using System; + +namespace BackSafe; + +sealed class Program +{ + // Initialization code. Don't use any Avalonia, third-party APIs or any + // SynchronizationContext-reliant code before AppMain is called: things aren't initialized + // yet and stuff might break. + [STAThread] + public static void Main(string[] args) => BuildAvaloniaApp() + .StartWithClassicDesktopLifetime(args); + + // Avalonia configuration, don't remove; also used by visual designer. + public static AppBuilder BuildAvaloniaApp() + => AppBuilder.Configure() + .UsePlatformDetect() + .WithInterFont() + .LogToTrace(); +} diff --git a/ViewLocator.cs b/ViewLocator.cs new file mode 100644 index 0000000..5ce19be --- /dev/null +++ b/ViewLocator.cs @@ -0,0 +1,31 @@ +using System; +using Avalonia.Controls; +using Avalonia.Controls.Templates; +using BackSafe.ViewModels; + +namespace BackSafe; + +public class ViewLocator : IDataTemplate +{ + + public Control? Build(object? param) + { + if (param is null) + return null; + + var name = param.GetType().FullName!.Replace("ViewModel", "View", StringComparison.Ordinal); + var type = Type.GetType(name); + + if (type != null) + { + return (Control)Activator.CreateInstance(type)!; + } + + return new TextBlock { Text = "Not Found: " + name }; + } + + public bool Match(object? data) + { + return data is ViewModelBase; + } +} diff --git a/ViewModels/MainWindowViewModel.cs b/ViewModels/MainWindowViewModel.cs new file mode 100644 index 0000000..5fbe926 --- /dev/null +++ b/ViewModels/MainWindowViewModel.cs @@ -0,0 +1,6 @@ +namespace BackSafe.ViewModels; + +public partial class MainWindowViewModel : ViewModelBase +{ + public string Greeting { get; } = "Welcome to Avalonia!"; +} diff --git a/ViewModels/ViewModelBase.cs b/ViewModels/ViewModelBase.cs new file mode 100644 index 0000000..b66f4f5 --- /dev/null +++ b/ViewModels/ViewModelBase.cs @@ -0,0 +1,7 @@ +using CommunityToolkit.Mvvm.ComponentModel; + +namespace BackSafe.ViewModels; + +public class ViewModelBase : ObservableObject +{ +} diff --git a/Views/MainWindow.axaml b/Views/MainWindow.axaml new file mode 100644 index 0000000..343c9d6 --- /dev/null +++ b/Views/MainWindow.axaml @@ -0,0 +1,20 @@ + + + + + + + + + + diff --git a/Views/MainWindow.axaml.cs b/Views/MainWindow.axaml.cs new file mode 100644 index 0000000..17b0ce1 --- /dev/null +++ b/Views/MainWindow.axaml.cs @@ -0,0 +1,11 @@ +using Avalonia.Controls; + +namespace BackSafe.Views; + +public partial class MainWindow : Window +{ + public MainWindow() + { + InitializeComponent(); + } +} \ No newline at end of file diff --git a/app.manifest b/app.manifest new file mode 100644 index 0000000..e176433 --- /dev/null +++ b/app.manifest @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + diff --git a/backsafe.sln b/backsafe.sln new file mode 100644 index 0000000..4a2d360 --- /dev/null +++ b/backsafe.sln @@ -0,0 +1,24 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.2.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BackSafe", "BackSafe.csproj", "{167A4AD4-4F11-F7F9-E8AC-6D41338AF814}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {167A4AD4-4F11-F7F9-E8AC-6D41338AF814}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {167A4AD4-4F11-F7F9-E8AC-6D41338AF814}.Debug|Any CPU.Build.0 = Debug|Any CPU + {167A4AD4-4F11-F7F9-E8AC-6D41338AF814}.Release|Any CPU.ActiveCfg = Release|Any CPU + {167A4AD4-4F11-F7F9-E8AC-6D41338AF814}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {BC0EECAB-90E8-450F-BBB1-AF85D5BD3409} + EndGlobalSection +EndGlobal