Repository files navigation

This SDK is compatible with Appwrite server version 1.7.x. For older versions, please checkprevious releases.

This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should checkappwrite/sdk-for-flutter

Appwrite is an open-source backend as a service server that abstract and simplify 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 Dart 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 tohttps://appwrite.io/docs

Add this to your package'spubspec.yaml file:

dependencies:dart_appwrite:^16.1.0

You can install packages from the command line:

dart pub add dart_appwrite

Once you add the dependencies, its extremely easy to get started with the SDK; All you need to do is import the package in your code, set your Appwrite credentials, and start making API calls. Below is a simple example:

import'package:dart_appwrite/dart_appwrite.dart';voidmain()async {Client client=Client()    .setEndpoint('http://[HOSTNAME_OR_IP]/v1')// Make sure your endpoint is accessible    .setProject('5ff3379a01d25')// Your project ID    .setKey('cd868c7af8bdc893b4...93b7535db89')    .setSelfSigned();// Use only on dev mode with a self-signed SSL certUsers users=Users(client);try {final user=await users.create(userId:ID.unique(), email:"email@example.com", phone:"+123456789", password:"password", name:"Walter O'Brien");print(user.toMap());  }onAppwriteExceptioncatch(e) {print(e.message);  }}

The Appwrite Dart SDK raisesAppwriteException object withmessage,code andresponse properties. You can handle any errors by catchingAppwriteException and present themessage to the user or handle it yourself based on the provided error information. Below is an example.

Users users=Users(client);try {final user=await users.create(userId:ID.unique(), email:"email@example.com", phone:"+123456789", password:"password", name:"Walter O'Brien");print(user.toMap());}onAppwriteExceptioncatch(e) {//show message to user or do other operation based on error as requiredprint(e.message);}

You can use the following resources to learn more and get help

• 🚀Getting Started Tutorial
• 📜Appwrite Docs
• 💬Discord Community
• 🚂Appwrite Dart Playground

This library is auto-generated by Appwrite customSDK Generator. To learn more about how you can help us improve this SDK, please check thecontribution guide before sending a pull-request.

Please see theBSD-3-Clause license file for more information.