Appwrite React Native SDK
此 SDK 与 Appwrite 服务器版本 1.5.x 兼容。对于旧版本,请查看以前的发布版本。
Appwrite 是一个开源的后端即服务(BaaS)服务器,它抽象并简化了复杂和重复的开发任务,并通过一个非常简单易用的 REST API 提供服务。Appwrite 旨在帮助您更快速、更安全地开发应用程序。使用 React Native SDK 将您的应用程序与 Appwrite 服务器集成,轻松开始与 Appwrite 后端 API 和工具交互。完整的 API 文档和教程请访问 https://appwrite.io/docs
安装
安装方法:
npx expo install react-native-appwrite react-native-url-polyfill
入门指南
添加您的平台
如果这是您第一次使用 Appwrite,请创建一个账户并创建您的第一个项目。
然后,在添加平台下,添加一个Android 应用或一个Apple 应用。您可以跳过可选步骤。
iOS 步骤
添加您的应用名称和Bundle ID。您可以在 XCode 中应用主目标的General标签下找到您的Bundle Identifier。对于 Expo 项目,您可以在项目根目录的 app.json 文件中设置或找到它。
Android 步骤
添加您的应用的名称和包名。您的包名通常是应用级 build.gradle 文件中的 applicationId。对于 Expo 项目,您可以在项目根目录的 app.json 文件中设置或找到它。
设置
在 index.js
中添加 react-native-url-polyfill
的导入
import 'react-native-url-polyfill/auto'
如果您正在为 iOS 构建,别忘了安装 pods
cd ios && pod install && cd ..
初始化您的 SDK
使用您的 Appwrite 服务器 API 端点和项目 ID 初始化您的 SDK,这些可以在您的项目设置页面中找到。
import { Client } from 'react-native-appwrite';
// 初始化您的 React Native SDK
const client = new Client();
client
.setEndpoint('http://localhost/v1') // 您的 Appwrite 端点
.setProject('455x34dfkj') // 您的项目 ID
.setPlatform('com.example.myappwriteapp') // 您的应用 ID 或包 ID
;
发送您的第一个请求
一旦设置好 SDK 对象,您可以访问任何 Appwrite 服务并选择任何要发送的请求。您可以在 SDK 文档或 API 参考 部分找到任何您想使用的服务方法的完整文档。
const account = new Account(client);
// 注册用户
account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
.then(function (response) {
console.log(response);
}, function (error) {
console.log(error);
});
完整示例
import { Client, Account } from 'react-native-appwrite';
// 初始化您的 React Native SDK
const client = new Client();
client
.setEndpoint('http://localhost/v1') // 您的 Appwrite 端点
.setProject('455x34dfkj')
.setPlatform('com.example.myappwriteapp') // 您的应用 ID
;
const account = new Account(client);
// 注册用户
account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe')
.then(function (response) {
console.log(response);
}, function (error) {
console.log(error);
});
了解更多
您可以使用以下资源了解更多信息并获取帮助
贡献
这个库是由 Appwrite 自定义的 SDK 生成器 自动生成的。要了解更多关于如何帮助我们改进这个 SDK 的信息,请在发送拉取请求之前查看贡献指南。
许可证
请查看 BSD-3-Clause 许可证 文件以获取更多信息。