From ea5e080809c35a2c27c3b102b21fb99eafbf07e4 Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Sun, 12 Apr 2020 09:15:33 +0300 Subject: [PATCH] Updated SDK docs --- app/config/platforms.php | 2 +- app/sdks/flutter-dart/README.md | 2 +- app/sdks/flutter-dart/example/README.md | 55 +++++++++++++++++++ app/sdks/flutter-dart/lib/client.dart | 2 +- .../flutter-dart/lib/services/avatars.dart | 1 - .../flutter-dart/lib/services/database.dart | 1 - .../flutter-dart/lib/services/locale.dart | 1 - .../flutter-dart/lib/services/storage.dart | 1 - app/sdks/flutter-dart/lib/services/teams.dart | 1 - app/sdks/flutter-dart/pubspec.yaml | 2 +- app/tasks/sdks.php | 3 + composer.lock | 4 +- docs/sdks/dart/EXAMPLES.md | 55 +++++++++++++++++++ 13 files changed, 119 insertions(+), 11 deletions(-) create mode 100644 app/sdks/flutter-dart/example/README.md create mode 100644 docs/sdks/dart/EXAMPLES.md diff --git a/app/config/platforms.php b/app/config/platforms.php index 06e1409a60..2f08c6ef21 100644 --- a/app/config/platforms.php +++ b/app/config/platforms.php @@ -130,7 +130,7 @@ return [ [ 'key' => 'dart', 'name' => 'Dart', - 'version' => '0.0.14', + 'version' => '0.1.0', 'url' => 'https://github.com/appwrite/sdk-for-dart', 'enabled' => true, 'beta' => true, diff --git a/app/sdks/flutter-dart/README.md b/app/sdks/flutter-dart/README.md index f5980071c5..5a8d15ffe5 100644 --- a/app/sdks/flutter-dart/README.md +++ b/app/sdks/flutter-dart/README.md @@ -20,7 +20,7 @@ Add this to your package's `pubspec.yaml` file: ```yml dependencies: - appwrite: ^0.0.14 + appwrite: ^0.1.0 ``` You can install packages from the command line: diff --git a/app/sdks/flutter-dart/example/README.md b/app/sdks/flutter-dart/example/README.md new file mode 100644 index 0000000000..f0ed67887b --- /dev/null +++ b/app/sdks/flutter-dart/example/README.md @@ -0,0 +1,55 @@ +# Examples + +Init your Appwrite client: + +```dart + Client client = Client(); + + client + .setEndpoint('https://localhost/v1') // Your Appwrite Endpoint + .setProject('5e8cf4f46b5e8') // Your project ID + .setSelfSigned() + ; + +``` + +Create a new user and session: + +```dart + Account account = Account(client); + + Response user = await account.create(email: 'me@appwrite.io', password: 'password', name: 'My Name'); + + Response session = await account.createSession(email: 'me@appwrite.io', password: 'password'); + +``` + +Fetch user profile: + +```dart +Account account = Account(client); + +Response profile = await account.get(); +``` + +Upload File: + +```dart +Storage storage = Storage(client); + +MultipartFile file = MultipartFile.fromFile('./path-to-file/image.jpg', filename: 'image.jpg'); + +storage.createFile( + file: file, + read: ['*'], + write: [] +) +.then((response) { + print(response); // File uploaded! +}) +.catchError((error) { + print(error.response); +}); +``` + +All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs) \ No newline at end of file diff --git a/app/sdks/flutter-dart/lib/client.dart b/app/sdks/flutter-dart/lib/client.dart index 1a03b9fc92..ff9c11291d 100644 --- a/app/sdks/flutter-dart/lib/client.dart +++ b/app/sdks/flutter-dart/lib/client.dart @@ -30,7 +30,7 @@ class Client { this.headers = { 'content-type': 'application/json', - 'x-sdk-version': 'appwrite:dart:0.0.14', + 'x-sdk-version': 'appwrite:dart:0.1.0', }; this.config = {}; diff --git a/app/sdks/flutter-dart/lib/services/avatars.dart b/app/sdks/flutter-dart/lib/services/avatars.dart index 90439b7ece..a85b667018 100644 --- a/app/sdks/flutter-dart/lib/services/avatars.dart +++ b/app/sdks/flutter-dart/lib/services/avatars.dart @@ -1,5 +1,4 @@ -import 'dart:io'; import 'package:dio/dio.dart'; import 'package:meta/meta.dart'; diff --git a/app/sdks/flutter-dart/lib/services/database.dart b/app/sdks/flutter-dart/lib/services/database.dart index 59a4e6d089..9b9ed854eb 100644 --- a/app/sdks/flutter-dart/lib/services/database.dart +++ b/app/sdks/flutter-dart/lib/services/database.dart @@ -1,5 +1,4 @@ -import 'dart:io'; import 'package:dio/dio.dart'; import 'package:meta/meta.dart'; diff --git a/app/sdks/flutter-dart/lib/services/locale.dart b/app/sdks/flutter-dart/lib/services/locale.dart index e61ee2bc75..ffce301c40 100644 --- a/app/sdks/flutter-dart/lib/services/locale.dart +++ b/app/sdks/flutter-dart/lib/services/locale.dart @@ -1,5 +1,4 @@ -import 'dart:io'; import 'package:dio/dio.dart'; import 'package:meta/meta.dart'; diff --git a/app/sdks/flutter-dart/lib/services/storage.dart b/app/sdks/flutter-dart/lib/services/storage.dart index 0c410f3787..47497c7699 100644 --- a/app/sdks/flutter-dart/lib/services/storage.dart +++ b/app/sdks/flutter-dart/lib/services/storage.dart @@ -1,5 +1,4 @@ -import 'dart:io'; import 'package:dio/dio.dart'; import 'package:meta/meta.dart'; diff --git a/app/sdks/flutter-dart/lib/services/teams.dart b/app/sdks/flutter-dart/lib/services/teams.dart index 2297369eb9..56e0731687 100644 --- a/app/sdks/flutter-dart/lib/services/teams.dart +++ b/app/sdks/flutter-dart/lib/services/teams.dart @@ -1,5 +1,4 @@ -import 'dart:io'; import 'package:dio/dio.dart'; import 'package:meta/meta.dart'; diff --git a/app/sdks/flutter-dart/pubspec.yaml b/app/sdks/flutter-dart/pubspec.yaml index 55f836f7bc..6393725d73 100644 --- a/app/sdks/flutter-dart/pubspec.yaml +++ b/app/sdks/flutter-dart/pubspec.yaml @@ -1,5 +1,5 @@ name: appwrite -version: 0.0.14 +version: 0.1.0 description: 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 homepage: https://appwrite.io repository: https://github.com/appwrite/sdk-for-dart diff --git a/app/tasks/sdks.php b/app/tasks/sdks.php index a47702e4cf..c4cc46ffa6 100644 --- a/app/tasks/sdks.php +++ b/app/tasks/sdks.php @@ -61,6 +61,8 @@ $cli $target = realpath(__DIR__.'/..').'/sdks/git/'.$language['key'].'/'; $readme = realpath(__DIR__ . '/../../docs/sdks/'.$language['key'].'/README.md'); $readme = ($readme) ? file_get_contents($readme) : ''; + $examples = realpath(__DIR__ . '/../../docs/sdks/'.$language['key'].'/EXAMPLES.md'); + $examples = ($examples) ? file_get_contents($examples) : ''; $changelog = realpath(__DIR__ . '/../../docs/sdks/'.$language['key'].'/CHANGELOG.md'); $changelog = ($changelog) ? file_get_contents($changelog) : '# Change Log'; $warning = ($language['beta']) ? '**This SDK is compatible with Appwrite server version ' . $version . '. For older versions, please check previous releases.**' : ''; @@ -156,6 +158,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ->setWarning($warning) ->setReadme($readme) ->setChangelog($changelog) + ->setExamples($examples) ; try { diff --git a/composer.lock b/composer.lock index 179b03e1f5..b02e80a923 100644 --- a/composer.lock +++ b/composer.lock @@ -1622,7 +1622,7 @@ "source": { "type": "git", "url": "https://github.com/appwrite/sdk-generator", - "reference": "f402438390464b371595fdc2372d6fde1ccf855a" + "reference": "9bccab4d66c3f90b759ed5fe3e346be33de70245" }, "require": { "ext-curl": "*", @@ -1652,7 +1652,7 @@ } ], "description": "Appwrite PHP library for generating API SDKs for multiple programming languages and platforms", - "time": "2020-04-11T16:34:07+00:00" + "time": "2020-04-12T06:12:36+00:00" }, { "name": "doctrine/instantiator", diff --git a/docs/sdks/dart/EXAMPLES.md b/docs/sdks/dart/EXAMPLES.md new file mode 100644 index 0000000000..af02a189d9 --- /dev/null +++ b/docs/sdks/dart/EXAMPLES.md @@ -0,0 +1,55 @@ +# Examples + +Init your Appwrite client: + +```dart + Client client = Client(); + + client + .setEndpoint('https://localhost/v1') // Your Appwrite Endpoint + .setProject('5e8cf4f46b5e8') // Your project ID + .setSelfSigned() // Remove in production + ; + +``` + +Create a new user and session: + +```dart + Account account = Account(client); + + Response user = await account.create(email: 'me@appwrite.io', password: 'password', name: 'My Name'); + + Response session = await account.createSession(email: 'me@appwrite.io', password: 'password'); + +``` + +Fetch user profile: + +```dart +Account account = Account(client); + +Response profile = await account.get(); +``` + +Upload File: + +```dart +Storage storage = Storage(client); + +MultipartFile file = MultipartFile.fromFile('./path-to-file/image.jpg', filename: 'image.jpg'); + +storage.createFile( + file: file, + read: ['*'], + write: [] +) +.then((response) { + print(response); // File uploaded! +}) +.catchError((error) { + print(error.response); +}); +``` + +All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs) \ No newline at end of file