You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-17Lines changed: 24 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,26 +36,13 @@ pub get appwrite
36
36
### Add your Flutter Platform
37
37
To init your SDK and start interacting with Appwrite services, you need to add a new Flutter platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before, and click the 'Add Platform' button.
38
38
39
-
From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for both iOSand Android.
39
+
From the options, choose to add a new **Flutter** platform and add your app credentials. Appwrite Flutter SDK currently supports building apps for Android, iOS, Linux, Mac OS, Web and Windows.
40
40
41
41
If you are building your Flutter application for multiple devices, you have to follow this process for each different device.
42
42
43
-
#### iOS
44
-
For **iOS** add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
45
-
46
-
#### Android
47
-
For **Android** add your app <u>name</u> and <u>package name</u>, Your package name is generally the applicationId in your app-level build.gradle file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
48
-
49
-
### iOS
50
-
51
-
The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
52
-
53
-
1. In Xcode, open Runner.xcworkspace in your app's ios folder.
54
-
2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
55
-
3. Select the General tab.
56
-
4. In Deployment Info, 'Target' select iOS 11.0
57
-
58
43
### Android
44
+
For **Android** first add your app <u>name</u> and <u>package name</u>, Your package name is generally the **applicationId** in your app-level <ahref="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/android/app/build.gradle#L41"target="_blank"rel="noopener">build.gradle</a> file. By registering your new app platform, you are allowing your app to communicate with the Appwrite API.
45
+
59
46
In order to capture the Appwrite OAuth callback url, the following activity needs to be added to your [AndroidManifest.xml](https://github.com/appwrite/playground-for-flutter/blob/master/android/app/src/main/AndroidManifest.xml). Be sure to replace the **[PROJECT_ID]** string with your actual Appwrite project ID. You can find your Appwrite project ID in your project settings screen in the console.
60
47
61
48
```xml
@@ -73,12 +60,31 @@ In order to capture the Appwrite OAuth callback url, the following activity need
73
60
</manifest>
74
61
```
75
62
63
+
### iOS
64
+
For **iOS** first add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
65
+
66
+
The Appwrite SDK uses ASWebAuthenticationSession on iOS 12+ and SFAuthenticationSession on iOS 11 to allow OAuth authentication. You have to change your iOS Deployment Target in Xcode to be iOS >= 11 to be able to build your app on an emulator or a real device.
67
+
68
+
1. In Xcode, open Runner.xcworkspace in your app's ios folder.
69
+
2. To view your app's settings, select the Runner project in the Xcode project navigator. Then, in the main view sidebar, select the Runner target.
70
+
3. Select the General tab.
71
+
4. In Deployment Info, 'Target' select iOS 11.0
72
+
73
+
### Linux
74
+
For **Linux** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <ahref="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1"target="_blank"rel="noopener">pubspec.yaml<a> file. If you cannot find the correct package name, run the application in linux, and make any request with proper exception handling, you should get the application ID needed to add in the received error message.
75
+
76
+
### Mac OS
77
+
For **Mac OS** add your app name and Bundle ID, You can find your Bundle Identifier in the General tab for your app's primary target in Xcode.
78
+
76
79
### Web
77
80
Appwrite 0.7, and the Appwrite Flutter SDK 0.3.0 have added support for Flutter Web. To build web apps that integrate with Appwrite successfully, all you have to do is add a web platform on your Appwrite project's dashboard and list the domain your website will use to allow communication to the Appwrite API.
78
81
79
82
#### Flutter Web Cross-Domain Communication & Cookies
80
83
While running Flutter Web, make sure your Appwrite server and your Flutter client are using the same top-level domain and the same protocol (HTTP or HTTPS) to communicate. When trying to communicate between different domains or protocols, you may receive HTTP status error 401 because some modern browsers block cross-site or insecure cookies for enhanced privacy. In production, Appwrite allows you set multiple [custom-domains](https://appwrite.io/docs/custom-domains) for each project.
81
84
85
+
### Windows
86
+
For **Windows** add your app <u>name</u> and <u>package name</u>, Your package name is generally the **name** in your <ahref="https://github.com/appwrite/playground-for-flutter/blob/0fdbdff98384fff940ed0b1e08cf14cfe3a2be3e/pubspec.yaml#L1"target="_blank"rel="noopener">pubspec.yaml</a> file. If you cannot find the correct package name, run the application in windows, and make any request with proper exception handling, you should get the application id needed to add in the received error message.
87
+
82
88
### Init your SDK
83
89
84
90
<p>Initialize your SDK with your Appwrite server API endpoint and project ID, which can be found in your project settings page.
@@ -155,12 +161,13 @@ try {
155
161
```
156
162
157
163
### Learn more
158
-
You can use followng resources to learn more and get help
164
+
You can use following resources to learn more and get help
159
165
- π [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)
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.
0 commit comments