From f70152d7fbf902e9de1fcfcfea894520b01c8d6f Mon Sep 17 00:00:00 2001 From: Gince Date: Sat, 4 May 2024 17:36:09 +0300 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(deps):=20Fake=20commit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 63 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b2c71d9..9ac225e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ **This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-react-native/releases).** -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 React Native 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) +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 React Native 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 ![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png) @@ -17,22 +17,23 @@ Appwrite is an open-source backend as a service server that abstract and simplif To install ```bash -npx expo install react-native-appwrite react-native-url-polyfill +npx expo install @arietta-studio/appwrite-sdk react-native-url-polyfill ``` - - ## Getting Started ### Add your Platform + If this is your first time using Appwrite, create an account and create your first project. Then, under **Add a platform**, add a **Android app** or a **Apple app**. You can skip optional steps. #### iOS steps + 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. For Expo projects you can set or find it on **app.json** file at your project's root directory. #### Android steps + Add your app's **name** and **package name**, Your package name is generally the **applicationId** in your app-level **build.gradle** file. For Expo projects you can set or find it on **app.json** file at your project's root directory. ## Setup @@ -47,61 +48,69 @@ import 'react-native-url-polyfill/auto' > `cd ios && pod install && cd ..` ### Init your SDK + Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page. ```js import { Client } from 'react-native-appwrite'; + // Init your React Native SDK const client = new Client(); client - .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint - .setProject('455x34dfkj') // Your project ID - .setPlatform('com.example.myappwriteapp') // Your application ID or bundle ID. -; + .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint + .setProject('455x34dfkj') // Your project ID + .setPlatform('com.example.myappwriteapp'); // Your application ID or bundle ID. ``` ### Make Your First Request + Once your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section. ```js const account = new Account(client); // Register User -account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe') - .then(function (response) { - console.log(response); - }, function (error) { - console.log(error); - }); - +account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe').then( + function (response) { + console.log(response); + }, + function (error) { + console.log(error); + }, +); ``` ### Full Example + ```js -import { Client, Account } from 'react-native-appwrite'; +import { Account, Client } from 'react-native-appwrite'; + // Init your React Native SDK const client = new Client(); client - .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint - .setProject('455x34dfkj') - .setPlatform('com.example.myappwriteapp') // YOUR application ID -; + .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint + .setProject('455x34dfkj') + .setPlatform('com.example.myappwriteapp'); // YOUR application ID const account = new Account(client); // Register User -account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe') - .then(function (response) { - console.log(response); - }, function (error) { - console.log(error); - }); +account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe').then( + function (response) { + console.log(response); + }, + function (error) { + console.log(error); + }, +); ``` ### Learn more + You can use the following resources to learn more and get help + - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/quick-starts/react-native) - 📜 [Appwrite Docs](https://appwrite.io/docs) - 💬 [Discord Community](https://appwrite.io/discord) @@ -113,4 +122,4 @@ This library is auto-generated by Appwrite custom [SDK Generator](https://github ## License -Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information. \ No newline at end of file +Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.