Repository files navigation

We just announced Auto-increment support for Appwrite Databases -Learn more

Get started with Appwrite

Appwrite is an all-in-one development platform for Web, Mobile, and Flutter applications. Use built-in backend infrastructure and web hosting, all from a single place. Built with the open source community and optimized for developer experience in the coding languages you love.

English |简体中文

Appwrite is an end-to-end platform for building Web, Mobile, Native, or Backend apps, packaged as a set of Docker microservices. It includes both a backend server and a fully integrated hosting solution for deploying static and server-side rendered frontends. Appwrite abstracts the complexity and repetitiveness required to build modern apps from scratch and allows you to build secure, full-stack applications faster.

Using Appwrite, you can easily integrate your app with user authentication and multiple sign-in methods, a database for storing and querying users and team data, storage and file management, image manipulation, Cloud Functions, messaging, andmore services.

Find out more at:https://appwrite.io.

Table of Contents:

• Installation & Setup
• Self-Hosting
  • Unix
  • Windows
    • CMD
    • PowerShell
  • Upgrade from an Older Version
• One-Click Setups
• Getting Started
  • Products
  • SDKs
    • Client
    • Server
    • Community
• Architecture
• Contributing
• Security
• Follow Us
• License

The easiest way to get started with Appwrite is bysigning up for Appwrite Cloud. While Appwrite Cloud is in public beta, you can build with Appwrite completely free, and we won't collect your credit card information.

Appwrite is designed to run in a containerized environment. Running your server is as easy as running one command from your terminal. You can either run Appwrite on your localhost using docker-compose or on any other container orchestration tool, such asKubernetes,Docker Swarm, orRancher.

Before running the installation command, make sure you haveDocker installed on your machine:

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.7.3

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.7.3

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.7.3

Once the Docker installation is complete, go tohttp://localhost to access the Appwrite console from your browser. Please note that on non-Linux native hosts, the server might take a few minutes to start after completing the installation.

For advanced production and custom installation, check out our Dockerenvironment variables docs. You can also use our publicdocker-compose.yml and.env files to manually set up an environment.

If you are upgrading your Appwrite server from an older version, you should use the Appwrite migration tool once your setup is completed. For more information regarding this, check out theInstallation Docs.

In addition to running Appwrite locally, you can also launch Appwrite using a pre-configured setup. This allows you to get up and running quickly with Appwrite without installing Docker on your local machine.

Choose from one of the providers below:

DigitalOcean

Gitpod

Akamai Compute

AWS Marketplace

Getting started with Appwrite is as easy as creating a new project, choosing your platform, and integrating its SDK into your code. You can easily get started with your platform of choice by reading one of our Getting Started tutorials.

• Account - Manage current user authentication and account. Track and manage the user sessions, devices, sign-in methods, and security logs.
• Users - Manage and list all project users when building backend integrations with Server SDKs.
• Teams - Manage and group users in teams. Manage memberships, invites, and user roles within a team.
• Databases - Manage databases, collections, and documents. Read, create, update, and delete documents and filter lists of document collections using advanced filters.
• Storage - Manage storage files. Read, create, delete, and preview files. Manipulate the preview of your files to perfectly fit your app. All files are scanned by ClamAV and stored in a secure and encrypted way.
• Functions - Customize your Appwrite project by executing your custom code in a secure, isolated environment. You can trigger your code on any Appwrite system event either manually or using a CRON schedule.
• Messaging - Communicate with your users through push notifications, emails, and SMS text messages using Appwrite Messaging.
• Realtime - Listen to real-time events for any of your Appwrite services including users, storage, functions, databases, and more.
• Locale - Track your user's location and manage your app locale-based data.
• Avatars - Manage your users' avatars, countries' flags, browser icons, and credit card symbols. Generate QR codes from links or plaintext strings.
• MCP - Use Appwrite's Model Context Protocol (MCP) server to allow LLMs and AI tools like Claude Desktop, Cursor, and Windsurf Editor to directly interact with your Appwrite project through natural language.
• Sites - Develop, deploy, and scale your web applications directly from Appwrite, alongside your backend.

For the complete API documentation, visithttps://appwrite.io/docs. For more tutorials, news and announcements check out ourblog andDiscord Server.

Below is a list of currently supported platforms and languages. If you would like to help us add support to your platform of choice, you can go over to ourSDK Generator project and view ourcontribution guide.

• ✅  Web (Maintained by the Appwrite Team)
• ✅  Flutter (Maintained by the Appwrite Team)
• ✅  Apple (Maintained by the Appwrite Team)
• ✅  Android (Maintained by the Appwrite Team)
• ✅  React Native -Beta (Maintained by the Appwrite Team)

• ✅  NodeJS (Maintained by the Appwrite Team)
• ✅  PHP (Maintained by the Appwrite Team)
• ✅  Dart (Maintained by the Appwrite Team)
• ✅  Deno (Maintained by the Appwrite Team)
• ✅  Ruby (Maintained by the Appwrite Team)
• ✅  Python (Maintained by the Appwrite Team)
• ✅  Kotlin (Maintained by the Appwrite Team)
• ✅  Swift (Maintained by the Appwrite Team)
• ✅  .NET -Beta (Maintained by the Appwrite Team)

• ✅  Appcelerator Titanium (Maintained byMichael Gangolf)
• ✅  Godot Engine (Maintained byfenix-hub @GodotNuts)

Looking for more SDKs? - Help us by contributing a pull request to ourSDK Generator!

Appwrite uses a microservices architecture that was designed for easy scaling and delegation of responsibilities. In addition, Appwrite supports multiple APIs, such as REST, WebSocket, and GraphQL to allow you to interact with your resources by leveraging your existing knowledge and protocols of choice.

The Appwrite API layer was designed to be extremely fast by leveraging in-memory caching and delegating any heavy-lifting tasks to the Appwrite background workers. The background workers also allow you to precisely control your compute capacity and costs using a message queue to handle the load. You can learn more about our architecture in thecontribution guide.

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in thecontribution guide.

For security issues, kindly email us atsecurity@appwrite.io instead of posting a public issue on GitHub.

Join our growing community around the world! Check out our officialBlog. Follow us onX,LinkedIn,Dev Community or join our liveDiscord server for more help, ideas, and discussions.

This repository is available under theBSD 3-Clause License.