Home

Awesome

Flutter SDK Todo

A todo list application built with the Atlas Device SDK for Flutter and Atlas Device Sync.

TIP: Follow along with the Flutter Tutorial to see how to build, modify, and run this template app.

[!WARNING] As of September 2024, Atlas Device SDKs are deprecated. Atlas Device SDKs will reach end-of-life and will no longer be maintained by MongoDB on September 30, 2025.

The template app in this repository should only be used as a reference for the on-device database and not to create a new app based on Device Sync. Refer to the deprecation page for details.

Create Your App

You can get started with this template app in two ways:

Create a Template App from the App Services UI or CLI (Recommended)

The easiest way to work with this template app is to create a new App Services App based on this Flutter template. The app is configured to run this client as a Real-Time Sync demo and comes pre-populated with the correct values for your app.

You're all set with a pre-configured app that's ready to run!

Clone from GitHub

If you choose to clone this project from GitHub, you can use it with an existing App Services App or you can create a new one. The only requirement is that your app has Device Sync enabled.

  1. Clone the GitHub mongodb/template-app-dart-flutter-todo repository.
  2. If you don't already have an App Services App, create an App with Device Sync enabled. This is the backend that you'll configure to use with this client template.
  3. Note your App ID, Project ID, and cluster name. You'll need it in the next step.

Configure Your App with this Client Template

  1. Open your /assets/config/atlasConfig.json file. It should contain the following:

    • appId: your Atlas App Services App ID. This should be similar to YOUR-APP-ID-123XYZ.
    • baseUrl: the App Services backend URL. This should be https://services.cloud.mongodb.com in most cases.
    • dataExplorerLink: the App Services Data Explorer URL that lets you view your synced data in Atlas from the app. This should be similar to https://cloud.mongodb.com/links/<YOUR-ATLAS-PROJECT-ID>/explorer/<YOUR-CLUSTER-NAME>/database/collection/find.

  2. Update with the values for your app:

Run the App

  1. Navigate to the project.
  2. Run flutter pub get
  3. Run the app:
    • on Windows, Linux and macOS: flutter run
    • on Android emulator or iOS Simulator:
      • if only one emulator or iOS Simulator is available: flutter run .
      • if multiple are available, get the device id: flutter devices, and start the app: flutter run -d <device-id>

For more information on running a Flutter app, refer to the Flutter Test Drive documentation.

Build on the App

Once you're up and running, you can get started building on this template.

Or you can follow along with the Flutter Tutorial to learn how to build on top of this template app.

Troubleshooting

Initializer error

[ERROR:flutter/runtime/dart_vm_initializer.cc(41)] Unhandled Exception: type 'Null' is not a subtype of type 'String'

This error occurs if the dataExplorerLink field in your /assets/config/atlasConfig.json is invalid.

To resolve it, ensure the dataExplorerLink field is populated with the correct project ID and cluster name values.

NOTE: If you used the Flutter template app, then this field should have been pre-populated with the correct URL.

Issues

Please report issues with the template at https://github.com/mongodb-university/realm-template-apps/issues/new.

Additional Resources