Quickstarts
Flutter Quickstart
Get started quickly with Ditto using the Ditto Quickstart Applications
Prerequisites
Ditto’s Flutter Quickstart supports iOS, Android, and Web. Before getting started, ensure you have the following:
- A code editor (Visual Studio Code is our recommendation, but any code editor will work)
- Git installed on your machine
- Flutter SDK (version 3.19.0 - 3.24.5) installed on your machine
- A Ditto Portal account with a configured Ditto Application (see Getting SDK Connection Details)
Android Specific Prerequisites
Android Specific Prerequisites
- Android Studio installed on your machine
- A physical Android device or Android emulator
iOS Specific Prerequisites
iOS Specific Prerequisites
- A macOS machine with the latest version of Xcode (15 or later) installed
- A physical iOS device or iOS simulator
Web Specific Prerequisites
Web Specific Prerequisites
- Ensure you have Flutter SDK version 3.22.0 - 3.24.5 installed
- Please refer to the Flutter for Web guide for additional information on Ditto’s support for Flutter Web.
Get Started
1. Clone the Repository
-
Open the terminal
-
Clone the repository from GitHub.
-
Navigate to the project directory:
2. Configure Ditto
Get Ditto App ID, Playground Token, Auth URL, and Websocket URL
- Log in to your Ditto Portal account
- Navigate to your application and obtain the Ditto App ID, Playground Token, Auth URL, and Websocket URL. (see Getting SDK Connection Details for more details)
Update Flutter Application with Ditto Credentials
- Open the
lib/main.dart
file or the appropriate configuration file where Ditto is initialized - Update the code with the App ID and Playground Token from your Ditto Application
Dart
3. Run the Application
- Navigate to the Flutter demo directory.
- Install the necessary dependencies. This fetches all required packages from pubspec.yaml.
- Run the Application
Android
Android
- Ensure you have an Android Emulator running or connect a physical device
- Select the Android Emulator/Device
iOS
iOS
- Ensure you have an iOS Simulator running or connect a physical iOS device
- Select the iOS Simulator/Device
Web
Web
- Ensure you have Google Chrome installed
- Run the application in the web browser
4. Sync-Data Offline
- Launch the application on multiple devices or simulators
- Disconnect from your current WiFi network while keeping WiFi enabled on the device to allow for LAN connections
- Add, edit, and delete tasks and experience offline collaboration!
Please note that the web platform only supports syncing data with the
Ditto cloud and does not support peer-to-peer sync
Next Steps
All the Ditto Quickstart apps works together! Try running a quickstart app in other languages and see them all collaborate.