It's going to get cloudy! ๐ฉ โ๏ธ The Appwrite Cloud is coming soon! You can learn more about our upcoming hosted solution and signup for free credits at: https://appwrite.io/cloud
A complete backend solution for [Flutter / Vue / Angular / React / iOS / Android / *ANY OTHER*] apps
English | ็ฎไฝไธญๆ
Appwrite 1.0 has been released! Learn what's new!
Appwrite is an end-to-end backend server for Web, Mobile, Native, or Backend apps packaged as a set of Docker microservices. Appwrite abstracts the complexity and repetitiveness required to build a modern backend API from scratch and allows you to build secure apps faster.
Using Appwrite, you can seamlessly integrate your app with user authentication and multiple sign-in methods. You can also find database and storage persistence, cloud functions, localization, image manipulation, file management, Cloud services, and more services.
@@ -40,16 +56,17 @@ Table of Contents:
- [Client](#client)
- [Server](#server)
- [Community](#community)
Installation
Appwrite backend server is designed to run in a container environment. You can get your server up and running with one command from your terminal. You can run Appwrite on your localhost using docker-compose, or on any other container orchestration tool like Kubernetes, Docker Swarm, or Rancher.
The easiest way to start running your Appwrite server is by running our docker-compose file. Before running the installation command, make sure you have Docker installed on your machine:
Unix
@@ -58,7 +75,7 @@ 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.0.3
### Windows
@@ -70,49 +87,77 @@ 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.0.3
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.0.3Once the Docker installation completes, go to http://localhost to access the Appwrite console. Please note that on non-Linux native hosts, the server might take a few minutes to start after installation completes.
For advanced production and custom installation, check out our Docker environment variables docs. You can also use our public docker-compose.yml and .env files to manually set up an environment.
Upgrade from an Older Version
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 migration, check out the Installation Docs.
One-Click Setups
In addition to running Appwrite locally, you can also launch Appwrite using a pre-configured setup. This allows you to start running Appwrite quickly without installing Docker on your local machine.
Choose from one of the providers below:
DigitalOcean |
Gitpod |
Getting Started
Get started with Appwrite in just three steps:
- create a new project
- choose your platform
- integrating its SDK into your code.
You can get started with your platform of choice by reading one of our "Getting Started" tutorials:
- Getting Started for Web
- Getting Started for Flutter
- Getting Started for Apple
- Getting Started for Android
- Getting Started for Server
- Getting Started for CLI
Services
- 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 fit your app perfectly. All files are scanned by ClamAV and stored in a secure and encrypted way.
- Functions - Customize your Appwrite server by executing your custom code in a secure, isolated environment. You can trigger your code on any Appwrite system event, manually or using a CRON schedule.
- 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, credit card symbols, and generate QR codes.
For the complete API documentation, visit https://appwrite.io/docs. For more tutorials, news and announcements check out our blog and Discord Server.
@@ -121,25 +166,39 @@ For the complete API documentation, visit [https://appwrite.io/docs](https://app
Below is a list of currently supported platforms and languages. If you wish to help us add support to your platform of choice, you can go over to our SDK Generator project and view our contribution guide.
Client
- โ Web (Maintained by the Appwrite Team)
- โ Flutter (Maintained by the Appwrite Team)
- โ Apple - Beta (Maintained by the Appwrite Team)
- โ Android (Maintained by the Appwrite Team)
Server
- โ NodeJS (Maintained by the Appwrite Team)
- โ PHP (Maintained by the Appwrite Team)
- โ Dart - (Maintained by the Appwrite Team)
- โ Deno - Beta (Maintained by the Appwrite Team)
- โ Ruby (Maintained by the Appwrite Team)
- โ Python (Maintained by the Appwrite Team)
- โ Kotlin - Beta (Maintained by the Appwrite Team)
- โ Apple - Beta (Maintained by the Appwrite Team)
- โ .NET - Experimental (Maintained by the Appwrite Team)
Community
- โ Appcelerator Titanium (Maintained by Michael Gangolf)
- โ Godot Engine (Maintained by fenix-hub @GodotNuts)
Looking for more SDKs? - Help us by contributing a pull request to our SDK Generator!
Architecture
Appwrite uses a microservices architecture that was designed for easy scaling and delegation of responsibilities. In addition, Appwrite supports multiple APIs (REST, WebSocket, with GraphQL coming soon) to allow you to interact with your resources by leveraging existing knowledge and protocols of choice.
The Appwrite API layer was designed to be extremely fast. It does this 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 the contribution guide.
Contributing
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. @@ -152,7 +211,7 @@ For security issues, kindly email us at [security@appwrite.io](mailto:security@a
Follow Us
Join our growing community around the world! See our official Blog. Follow us on Twitter, Facebook Page, Facebook Group, Dev Community or join our live Discord server for more help, ideas, and discussions.
License
This repository is available under the BSD 3-Clause License.