alexweininger / sdk-for-web

[READ-ONLY] Official Appwrite Web SDK 🧡

Appwrite Web SDK

This SDK is compatible with Appwrite server version 0.7.0. For older versions, please check previous releases.

Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

Installation

NPM

To install via NPM:

npm install appwrite --save

If you're using a bundler (like Browserify or webpack), you can import the Appwrite module when you need it:

import * as Appwrite from "appwrite";

CDN

To install with a CDN (content delivery network) add the following scripts to the bottom of your tag, but before you use any Appwrite services:

<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>

Getting Started

Initialise the Appwrite SDK in your code, and setup your API credentials:

// Init your Web SDK
var appwrite = new Appwrite();

appwrite
    .setEndpoint('http://localhost/v1') // Set only when using self-hosted solution
    .setProject('455x34dfkj') // Your Appwrite Project UID
;

Contribution

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the BSD-3-Clause license file for more information.