Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ditto.live/llms.txt

Use this file to discover all available pages before exploring further.

This content is for SDK V4. For the latest version, see the V5 documentation.

Prerequisites

Ditto’s .NET MAUI Quickstart supports iOS, Android, Mac Catalyst and Windows. Before getting started, ensure you have the following:
  • Git installed on your machine
  • .NET 9 SDK installed on your machine
  • .NET MAUI workloads installed on your machine. From the project root, open a terminal and run:
    sudo dotnet workload install maui
    sudo dotnet workload restore
    
  • A Ditto Portal account with a configured Ditto Database (see Getting SDK Connection Details)
  • Android Studio installed on your machine
  • A physical Android device or Android emulator
  • A macOS machine with the latest version of Xcode (16 or later) installed
  • A physical iOS device or iOS simulator
  • A macOS machine with macOS 15 (Sequoia) or later
  • Xcode 16 or later installed
  • A Windows machine running Windows 10 version 1809 (build 17763) or later

Get Started

1. Clone the Repository

2. Configure Ditto

Get Ditto Database ID, Playground Token, Auth URL, and Websocket URL

Add Ditto Credentials

  1. Copy the .env.sample file at the top level of the quickstart repo to .env and add your app ID and online playground token.
    cp .env.sample .env
    
  2. Update the .env file with the Database ID and Playground Token from your Ditto Database
    DITTO_APP_ID="REPLACE_ME_WITH_YOUR_APP_ID"
    DITTO_PLAYGROUND_TOKEN="REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN"
    DITTO_AUTH_URL="REPLACE_ME_WITH_YOUR_AUTH_URL"
    DITTO_WEBSOCKET_URL="REPLACE_ME_WITH_YOUR_WEBSOCKET_URL"
    

3. Run the Application

  1. Navigate to the project directory
    cd dotnet-maui/DittoMauiTasksApp
    
  2. Build and Run the Application
    dotnet build -t:Run -f net9.0-android
    

4. Sync-Data Offline

Next Steps

All the Ditto Quickstart apps works together! Try running a quickstart app in other languages and see them all collaborate.

Additional Resources