Skip to content
End to end backend server for frontend and mobile developers. πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»
JavaScript PHP HTML CSS Python Ruby Other
Branch: master
Clone or download

README.md

Appwrite Logo

Simple Backend Server for your [Vue / Angular / React / iOS / Android / Flutter / *ANY*] Frontend App

Docker Pulls Chat With Us Build Status Follow  Appwrite on StackShare


Appwrite is a simple to use backend for frontend and mobile apps. Appwrite provides client side (and server) developers with a set of REST APIs to speed up their app development times.

Using Appwrite you can easily manage user authentication with multiple sign-in methods, database for storing and querying user and teams data, storage and file management, image manipulation and cropping, scheduled cron tasks and many other features to help you get more results in faster times and with a lot less code.

https://appwrite.io

Appwrite

Installation

Appwrite backend server is designed to run in a container environment. Running your server is as easy as running 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:

mkdir appwrite-ce && \
cd appwrite-ce && \
curl -o docker-compose.yml https://appwrite.io/docker-compose.yml?port=80 && \
docker-compose up -d --remove-orphans

Once the Docker installation completes, go to http://localhost to access the Appwrite console from your browser. Please notice that on non-linux native hosts the server might take a few minutes to start after installation completes. For complete API documentation, visit https://appwrite.io/docs

Changing Port Number

In case your port 80 is already taken, change the port number in the command above. Make sure to set the correct endpoint in your selected SDK, including your new port number.

Getting Started

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

Services

  • Auth - Manage user authentication using multiple signin methods and account recovery.
  • Account - Manage current user account. Track and manage the user sessions, devices and security audit log.
  • Users - Manage and list all project users when in admin mode.
  • Teams - Manage and group users in teams. Manage memberships, invites and users roles within a team.
  • Database - Manage database collections and document. Read, create, update and delete documents and filter lists of documents collections using advanced filter with graph like capabilities.
  • Storage - Manage storage files. Read, create, delete and preview files. Manipulate your files preview to fit your app perfectly. All files are scanned by ClamAV and stored in a secure and encrypted way.
  • Locale - Track users location, and manage your app locale based data.
  • Avatars - Manage your users avatars, countries flags, browser icons, credit card symbols and generate QR codes.

SDKs

Currently we are supporting a few SDK libraries and we are constantly working on adding new ones.

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.

  • βœ… JS (Maintained by the Appwrite Team)
  • βœ… PHP (Maintained by the Appwrite Team)
  • βœ… NodeJS (Maintained by the Appwrite Team)
  • βœ… Ruby - Work in progress (Maintained by the Appwrite Team)
  • βœ… Python - Work in progress (Maintained by the Appwrite Team)
  • ✳️ Looking for more SDKs? - Help us by contributing a pull request to our SDK Generator!

Contributing

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

Fork the project, create a feature branch, and send us a pull request.

For security issues, please email security@appwrite.io instead of posting a public issue in GitHub.

You can’t perform that action at this time.