README

Appwrite 初始化已结束！您可以在我们的初始化网站上查看所有最新公告 https://appwrite.io/init 🚀

Appwrite 是一个用于开发 Web、移动和 Flutter 应用的后端平台。它由开源社区构建，并针对您所喜爱的编码语言中的开发者体验进行了优化。

英文 | 简体中文

宣布 Appwrite 云公共测试版！今天注册！

Appwrite 是一个打包为 Docker 微服务集的端到端后端服务器，适用于 Web、移动、原生或后端应用。Appwrite 抽象了从头开始构建现代后端 API 所需的复杂性和重复性，让您能够更快地构建安全的应用程序。

使用 Appwrite，您可以轻松地将您的应用程序与用户身份验证和多种登录方法集成，存储和查询用户和团队数据的数据库，存储和文件管理，图像处理，云函数，以及更多服务。

更多信息请访问：https://appwrite.io

安装
- Unix
- Windows
  - CMD
  - PowerShell
- 从旧版本升级
一键安装
入门
- 服务
- SDK
架构
贡献
安全
关注我们
许可证

安装

Appwrite 设计用于在容器化环境中运行。在您的终端中运行一个命令即可轻松运行服务器。您可以在本地主机上使用 docker-compose 运行 Appwrite，或者在任何其他容器编排工具上，例如 Kubernetes、Docker Swarm 或 Rancher。

开始运行您的 Appwrite 服务器最简单的方法是运行我们的 docker-compose 文件。在运行安装命令之前，请确保您的机器上已安装 Docker。

Unix

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:1.6.0

Windows

CMD

docker run -it --rm ^
    --volume //var/run/docker.sock:/var/run/docker.sock ^
    --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
    --entrypoint="install" ^
    appwrite/appwrite:1.6.0

PowerShell

docker run -it --rm `
    --volume /var/run/docker.sock:/var/run/docker.sock `
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
    --entrypoint="install" `
    appwrite/appwrite:1.6.0

Docker 安装完成后，请访问 http://localhost 以通过浏览器访问 Appwrite 控制台。请注意，在非 Linux 原生主机上，服务器可能需要几分钟才能在完成安装后启动。

有关高级生产环境和自定义安装的信息，请参阅我们的 Docker 环境变量文档。您还可以使用我们的公共 docker-compose.yml 和 .env 文件手动设置环境。

从旧版本升级

如果您正在从旧版本升级 Appwrite 服务器，则应在设置完成后使用 Appwrite 迁移工具。有关此信息，请参阅安装文档。

一键安装

除了在本地运行Appwrite之外，您还可以使用预配置的设置来启动Appwrite。这允许您在不安装Docker的情况下快速开始使用Appwrite。

从以下提供商中选择一个

入门

开始使用Appwrite就像创建一个新项目、选择您的平台并将其SDK集成到您的代码中一样简单。您可以通过阅读我们的入门教程之一轻松开始使用您选择的平台。

产品

账户 - 管理当前用户的身份验证和账户。跟踪和管理用户会话、设备、登录方式和安全日志。
用户 - 在使用服务器SDK构建后端集成时，管理和列出所有项目用户。
团队 - 管理和分组用户。管理团队内的成员资格、邀请和用户角色。
数据库 - 管理数据库、集合和文档。读取、创建、更新和删除文档，并使用高级过滤器过滤文档集合列表。
存储 - 管理存储文件。读取、创建、删除和预览文件。操作文件的预览以完美适应您的应用程序。所有文件都经过ClamAV扫描并以安全加密的方式存储。
函数 - 通过在安全隔离的环境中执行您的自定义代码来自定义您的Appwrite项目。您可以通过手动或使用CRON计划来触发您的代码以响应任何Appwrite系统事件。
消息 - 使用Appwrite消息通过推送通知、电子邮件和短信文本消息与您的用户进行通信。
实时 - 监听您的任何Appwrite服务（包括用户、存储、函数、数据库等）的实时事件。
地区 - 跟踪您用户的位置并管理基于地区的数据。
头像 - 管理您用户的头像、国家国旗、浏览器图标和信用卡符号。从链接或纯文本字符串生成QR码。

要查看完整的API文档，请访问 https://appwrite.io/docs。有关更多教程、新闻和公告，请查看我们的博客和 Discord服务器。

SDK

以下是目前支持的平台和语言列表。如果您想帮助我们添加对您选择平台的支持，您可以去我们的 SDK生成器项目，并查看我们的贡献指南。

客户端

✅ Web （由Appwrite团队维护）
✅ Flutter （由Appwrite团队维护）
✅ Apple （由Appwrite团队维护）
✅ Android (由Appwrite团队维护)
✅ React Native - 测试版 (由Appwrite团队维护)

服务器

✅ NodeJS (由Appwrite团队维护)
✅ PHP (由Appwrite团队维护)
✅ Dart (由Appwrite团队维护)
✅ Deno (由Appwrite团队维护)
✅ Ruby (由Appwrite团队维护)
✅ Python (由Appwrite团队维护)
✅ Kotlin (由Appwrite团队维护)
✅ Swift (由Appwrite团队维护)
✅ .NET - 测试版 (由Appwrite团队维护)

社区

✅ Appcelerator Titanium (由Michael Gangolf维护)
✅ Godot Engine (由fenix-hub @GodotNuts维护)

寻找更多SDK？ - 通过向我们提交拉取请求来帮助我们，在我们的SDK生成器中贡献力量！

架构

Appwrite采用微服务架构，该架构旨在易于扩展和责任委派。此外，Appwrite支持多个API，例如REST、WebSocket和GraphQL，允许您利用现有的知识和选择的协议与资源进行交互。

Appwrite API层旨在通过利用内存缓存并将任何重负载任务委派给Appwrite后台工作者来达到极高的速度。后台工作者还允许您通过消息队列来处理负载，精确控制计算能力和成本。您可以在贡献指南中了解更多关于我们架构的信息。

贡献

所有代码贡献，包括有提交访问权限的人的贡献，都必须通过拉取请求，并经核心开发者批准后才能合并。这是为了确保对所有代码的适当审查。

我们真的很喜欢拉取请求！如果您想帮忙，您可以在贡献指南中了解更多关于如何为此项目贡献的方法。

安全

对于安全问题，请通过电子邮件发送到[email protected]，而不是在GitHub上发布公开问题。

关注我们

加入我们全球不断壮大的社区！查看我们的官方博客。在X、LinkedIn、Dev Community上关注我们，或加入我们的Discord服务器以获得更多帮助、想法和讨论。

许可证

本存储库受BSD 3-Clause License许可。

appwrite / server-ce

维护者

详细信息