mirror of
https://github.com/appwrite/sdk-for-dart.git
synced 2026-06-06 19:27:59 +00:00
80 lines
3.6 KiB
Markdown
80 lines
3.6 KiB
Markdown
# Appwrite Dart SDK
|
|
|
|
[](https://pub.dartlang.org/packages/dart_appwrite)
|
|
|
|
|
|
[](https://travis-ci.com/appwrite/sdk-generator)
|
|
[](https://twitter.com/appwrite)
|
|
[](https://appwrite.io/discord)
|
|
|
|
**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dart/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](https://github.com/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](https://appwrite.io/docs)
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Add this to your package's `pubspec.yaml` file:
|
|
|
|
```yml
|
|
dependencies:
|
|
dart_appwrite: ^20.1.2
|
|
```
|
|
|
|
You can install packages from the command line:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```dart
|
|
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@example.com',
|
|
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.
|
|
|
|
```dart
|
|
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
|
|
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
|
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
|
- 💬 [Discord Community](https://appwrite.io/discord)
|
|
- 🚂 [Appwrite Dart Playground](https://github.com/appwrite/playground-for-dart)
|
|
|
|
|
|
## Contribution
|
|
|
|
This 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.
|
|
|
|
## License
|
|
|
|
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information. |