4.9 KiB
Simple Backend Server
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 use for building software projects.
Using Appwrite you can easily manage user authentication with multiple sign-in methods, database as a service, storage and file uploads, image manipulation and cropping, scheduled cron tasks and many more features to help you get more results in faster time and with a lot less code.
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 container orchestration tool like kubernetes or rancher.
The easiest way to start running your Appwrite server is by running our docker compose file:
mkdir appwrite
&& cd appwrite
&& curl -o docker-compose.yml https://raw.githubusercontent.com/appwrite/appwrite/master/README.md
&& docker-compose up -d --remove-orphans
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 esily get started with your platform of choice by reading one of our getting started tutorials.
- Getting Started for Web
- Getting Started for Android (soon...)
- Getting Started for iOS (soon...)
- Getting Started for Server
Services
Service | Description | Tutotrials | Docs |
Auth | Manage user authentication using multiple signin methods and account recovery. | API References | |
Account | Manage current user account. Track and manage the user sessions, devices and security audit log. | API References | |
Users | Manage and list all project users when in admin mode. | API References | |
Teams | Manage and group users in teams. Manage memebrships, invites and users roles within a team. | API References | |
Database | Manage database collections and document. Read, create, update and delete documents and filter lists of documents colllections using advanced filter with graph like capebilities. | API References | |
Storage | Manage storage files. Read, create, delete and preview files. Manipulate your files preview to fit your app perfectly. All files are scaned by ClamAV and stored in a secure and encrypted way. | API References | |
Localisation | Track users location, and manage your app locale based data. | API References | |
Avatars | Manage your users avatars, countries flags, browser icons, credit card symbols and generate QR codes. | API References |
SDKs
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.