Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appwrite/sdk-for-dart
[READ-ONLY] Official Appwrite Dart SDK 💙
https://github.com/appwrite/sdk-for-dart
appwrite baas dart hacktoberfest mbaas
Last synced: about 1 month ago
JSON representation
[READ-ONLY] Official Appwrite Dart SDK 💙
- Host: GitHub
- URL: https://github.com/appwrite/sdk-for-dart
- Owner: appwrite
- License: bsd-3-clause
- Created: 2019-09-20T05:30:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T00:52:22.000Z (about 1 month ago)
- Last Synced: 2024-07-31T03:47:09.015Z (about 1 month ago)
- Topics: appwrite, baas, dart, hacktoberfest, mbaas
- Language: Dart
- Homepage: https://appwrite.io
- Size: 667 KB
- Stars: 112
- Watchers: 16
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-appwrite - Appwrite Dart SDK
README
# 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 1.5.x. 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 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 to [https://appwrite.io/docs](https://appwrite.io/docs)
## Installation
Add this to your package's `pubspec.yaml` file:
```yml
dependencies:
dart_appwrite: ^11.0.3
```
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
import 'package:dart_appwrite/dart_appwrite.dart';
void main() 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 cert
Users users = Users(client);
try {
final user = await users.create(userId: ID.unique(), email: "[email protected]", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
print(e.message);
}
}
```
### 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
Users users = Users(client);
try {
final user = await users.create(userId: ID.unique(), email: "[email protected]", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
print(e.message);
}
```
### 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.