Home
Softono
sdk-for-dart

sdk-for-dart

Open source BSD-3-Clause Dart
Website GitHub
118
Stars
22
Forks
9
Issues
12
Watchers
1 week
Last Commit
JavaScript Libraries & Components Backend as a Service

About sdk-for-dart

The official Dart SDK for integrating with Appwrite, an open-source backend as a service platform that simplifies development through a REST API. This server-side SDK allows Dart applications to interact with Appwrite's backend APIs and tools, including user management, databases, storage, and more. Compatible with Appwrite server version 1.9.x. Installation is done by adding dartappwrite to pubspec.yaml dependencies or via dart pub add. The SDK provides straightforward initialization by setting project ID and API key credentials, then enables API calls such as user creation. Errors are handled through the AppwriteException object, which includes message, code, and response properties. The library is auto-generated by Appwrite's SDK generator and is intended for server-side Dart code, not Flutter (which has its own SDK). Licensed under BSD-3-Clause.

Platforms

Web Self-hosted iOS Android

Languages

Dart

Links

Website Source Code
a
Published by
appwrite
Visit View Profile

README.md

View on GitHub

Appwrite Dart SDK

pub package License Version Build Status Twitter Account Discord

This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check previous 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 check appwrite/sdk-for-flutter

Appwrite 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 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 to https://appwrite.io/docs

Appwrite

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  dart_appwrite: ^25.1.0

You can install packages from the command line:

dart pub add dart_appwrite

Getting Started

Initialize & Make API Request

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:

Client client = Client()
  .setProject('<YOUR_PROJECT_ID>')
  .setKey('<YOUR_API_KEY>');

Users users = Users(client);

User user = await users.create(
  userId: ID.unique(),
  email: '[email protected]',
  phone: '+123456789',
  password: 'password',
  name: 'Walter O'Brien'
);

Error handling

The Appwrite Dart SDK raises AppwriteException object with message, 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.

try {
  User user = await users.create(...);
} on AppwriteException catch(e) {
  // Handle the error
}

Learn more

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

Contribution

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

License

Please see the BSD-3-Clause license file for more information.