{"id":13534126,"url":"https://github.com/appwrite/sdk-for-flutter","last_synced_at":"2026-04-02T13:59:22.310Z","repository":{"id":38185888,"uuid":"264599412","full_name":"appwrite/sdk-for-flutter","owner":"appwrite","description":"[READ-ONLY] Official Appwrite Flutter SDK 💙","archived":false,"fork":false,"pushed_at":"2026-03-25T07:18:39.000Z","size":1232,"stargazers_count":419,"open_issues_count":19,"forks_count":152,"subscribers_count":21,"default_branch":"main","last_synced_at":"2026-03-25T16:52:45.198Z","etag":null,"topics":["appwrite","baas","dart","dartlang","desktop","flutter","hacktoberfest","mobile"],"latest_commit_sha":null,"homepage":"https://appwrite.io","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appwrite.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-05-17T06:32:52.000Z","updated_at":"2026-03-20T14:46:26.000Z","dependencies_parsed_at":"2025-11-13T08:03:22.004Z","dependency_job_id":null,"html_url":"https://github.com/appwrite/sdk-for-flutter","commit_stats":{"total_commits":193,"total_committers":14,"mean_commits":"13.785714285714286","dds":0.7616580310880829,"last_synced_commit":"67f4c149e2bcd0cd6902f684e59a88c2ee101a6c"},"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"purl":"pkg:github/appwrite/sdk-for-flutter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-flutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-flutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-flutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-flutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appwrite","download_url":"https://codeload.github.com/appwrite/sdk-for-flutter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fsdk-for-flutter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31307435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appwrite","baas","dart","dartlang","desktop","flutter","hacktoberfest","mobile"],"created_at":"2024-08-01T07:01:26.727Z","updated_at":"2026-04-02T13:59:22.305Z","avatar_url":"https://github.com/appwrite.png","language":"Dart","readme":"# Appwrite Flutter SDK\n\n[![pub package](https://img.shields.io/pub/v/appwrite?style=flat-square)](https://pub.dartlang.org/packages/appwrite)\n![License](https://img.shields.io/github/license/appwrite/sdk-for-flutter.svg?style=flat-square)\n![Version](https://img.shields.io/badge/api%20version-1.9.x-blue.svg?style=flat-square)\n[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)\n[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee\u0026label=twitter\u0026style=flat-square)](https://twitter.com/appwrite)\n[![Discord](https://img.shields.io/discord/564160730845151244?label=discord\u0026style=flat-square)](https://appwrite.io/discord)\n\n**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-flutter/releases).**\n\nAppwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Flutter SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)\n\n![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)\n\n## Installation\n\nAdd this to your package's `pubspec.yaml` file:\n\n```yml\ndependencies:\n  appwrite: ^23.0.0\n```\n\nYou can install packages from the command line:\n\n```bash\nflutter pub add appwrite\n```\n\n\n## Getting Started\n\n### Add your Flutter Platform\nTo init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.\n\nFrom the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for Android, iOS, Linux, Mac OS, Web and Windows.\n\nIf you are building your Flutter application for multiple devices, you have to follow this process for each different device.\n\n### Android\nFor **Android** first add your app \u003cu\u003ename\u003c/u\u003e and \u003cu\u003epackage name\u003c/u\u003e, Your package name is generally the **applicationId** in your app-level \u003ca href=\"https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/android/app/build.gradle#L41\" target=\"_blank\" rel=\"noopener\"\u003ebuild.gradle\u003c/a\u003e file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.\n\nIn order to capture the Appwrite OAuth callback url, the following activity needs to be added inside the `\u003capplication\u003e` tag, along side the existing `\u003cactivity\u003e` tags in your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to replace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in your project settings screen in the console.\n\n```xml\n\u003cmanifest ...\u003e\n    ....\n    \u003capplication ...\u003e\n        ....\n        \u003c!-- Add this inside the \u003capplication\u003e tag, alongside the existing \u003cactivity\u003e tags --\u003e\n        \u003cactivity android:exported=\"true\" android:name=\"com.linusu.flutter_web_auth_2.CallbackActivity\" \u003e\n            \u003cintent-filter android:label=\"flutter_web_auth_2\"\u003e\n                \u003caction android:name=\"android.intent.action.VIEW\" /\u003e\n                \u003ccategory android:name=\"android.intent.category.DEFAULT\" /\u003e\n                \u003ccategory android:name=\"android.intent.category.BROWSABLE\" /\u003e\n                \u003cdata android:scheme=\"appwrite-callback-[PROJECT_ID]\" /\u003e\n            \u003c/intent-filter\u003e\n        \u003c/activity\u003e\n    \u003c/application\u003e\n\u003c/manifest\u003e\n```\n\n### iOS\nFor **iOS** first add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.\n\nThe Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS \u003e= 11 to be able to build your app on an emulator or a real device.\n\n1. In Xcode, open Runner.xcworkspace in your app's ios folder.\n2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.\n3. Select the General tab.\n4. In Deployment Info, 'Target' select iOS 11.0\n\n### Linux\nFor **Linux** add your app \u003cu\u003ename\u003c/u\u003e and \u003cu\u003epackage name\u003c/u\u003e, Your package name is generally the **name** in your \u003ca href=\"https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1\" target=\"_blank\" rel=\"noopener\"\u003epubspec.yaml\u003ca\u003e file. If you cannot find the correct package name, run the application in linux, and make any request with proper exception handling, you should get the application ID needed to add in the received error message.\n\n### macOS\nFor **macOS** add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.\n\nThe Appwrite SDK uses ASWebAuthenticationSession on macOS 10.15+ to allow OAuth authentication. You have to change your macOS Deployment Target in Xcode to be macOS \u003e= 10.15 to be able to build your app for macOS.\n\n### Web\nAppwrite 0.7, and the Appwrite Flutter SDK 0.3.0 have added support for Flutter Web. To build web apps that integrate with Appwrite successfully, all you have to do is add a web platform on your Appwrite project's dashboard and list the domain your website will use to allow communication to the Appwrite API.\n\nFor web in order to capture the OAuth2 callback URL and send it to the application using JavaScript `postMessage()`, you need to create an html file inside `./web` folder of your Flutter project. For example `auth.html` with the following content.\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003ctitle\u003eAuthentication complete\u003c/title\u003e\n\u003cp\u003eAuthentication is complete. If this does not happen automatically, please close the window.\u003c/p\u003e\n\u003cscript\u003e\n  function postAuthenticationMessage() {\n    const message = {\n      'flutter-web-auth-2': window.location.href\n    };\n\n    if (window.opener) {\n      window.opener.postMessage(message, window.location.origin);\n      window.close();\n    } else if (window.parent \u0026\u0026 window.parent !== window) {\n      window.parent.postMessage(message, window.location.origin);\n    } else {\n      localStorage.setItem('flutter-web-auth-2', window.location.href);\n      window.close();\n    }\n  }\n\n  postAuthenticationMessage();\n\u003c/script\u003e\n```\n\nRedirection URL passed to the authentication service must be the same as the URL on which the application is running (schema, host, port if necessary) and the path must point to created HTML file, /auth.html in this case. The callbackUrlScheme parameter of the authenticate() method does not take into account, so it is possible to use a schema for native platforms in the code.\n\n#### Flutter Web Cross-Domain Communication \u0026 Cookies\nWhile running Flutter Web, make sure your Appwrite server and your Flutter client are using the same top-level domain and the same protocol (HTTP or HTTPS) to communicate. When trying to communicate between different domains or protocols, you may receive HTTP status error 401 because some modern browsers block cross-site or insecure cookies for enhanced privacy. In production, Appwrite allows you set multiple [custom-domains](https://appwrite.io/docs/custom-domains) for each project.\n\n### Windows\nFor **Windows** add your app \u003cu\u003ename\u003c/u\u003e and \u003cu\u003epackage name\u003c/u\u003e, Your package name is generally the **name** in your \u003ca href=\"https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1\" target=\"_blank\" rel=\"noopener\"\u003epubspec.yaml\u003c/a\u003e file. If you cannot find the correct package name, run the application in windows, and make any request with proper exception handling, you should get the application id needed to add in the received error message.\n\n### Init your SDK\n\n\u003cp\u003eInitialize your SDK with your project ID, which can be found in your project settings page.\n\n```dart\nClient client = Client().setProject('\u003cYOUR_PROJECT_ID\u003e');\n```\n\n\u003e If using a self-hosted instance, you will also need to set your Appwrite endpoint using the `setEndpoint` method. Before starting to send any API calls to your new Appwrite instance, make sure your Android or iOS emulators has network access to the Appwrite server hostname or IP address.\n\u003e When trying to connect to a local Appwrite instance from an emulator or a mobile device, localhost is the hostname for the device or emulator and not your machine. You should replace localhost with your machine's private IP as the Appwrite endpoint's hostname (e.g. 192.168.1.100). You can also use a service like [ngrok](https://ngrok.com/) to proxy the Appwrite API.\n\n### Make Your First Request\n\n\u003cp\u003eOnce your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.\n\n```dart\nAccount account = Account(client);\n\nUser user = await account.create(\n  userId: ID.unique(),\n  email: 'email@example.com',\n  password: 'password',\n  name: 'Walter O'Brien',\n);\n```\n\n### Full Example\n\n```dart\nClient client = Client().setProject('\u003cYOUR_PROJECT_ID\u003e\u003e');\n\nAccount account = Account(client);\n\nUser user = await account.create(\n  userId: ID.unique(),\n  email: 'email@example.com',\n  password: 'password',\n  name: 'Walter O'Brien'\n);\n```\n\n### Error Handling\nThe Appwrite Flutter SDK raises `AppwriteException` object with `message`, `type`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.\n\n```dart\ntry {\n  User user = await account.create(...);\n} on AppwriteException catch(e) {\n  // Handle the exception\n}\n```\n\n### Learn more\nYou can use the following resources to learn more and get help\n- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)\n- 📜 [Appwrite Docs](https://appwrite.io/docs)\n- 💬 [Discord Community](https://appwrite.io/discord)\n- 🚂 [Appwrite Flutter Playground](https://github.com/appwrite/playground-for-flutter)\n\n\n## Contribution\n\nThis library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.\n\n## License\n\nPlease see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.","funding_links":[],"categories":["SDK","Dart"],"sub_categories":["Official Appwrite SDKs"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-flutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappwrite%2Fsdk-for-flutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fsdk-for-flutter/lists"}