44 lines
No EOL
1.7 KiB
Markdown
44 lines
No EOL
1.7 KiB
Markdown
# Appwrite Web SDK
|
|
|
|
![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1)
|
|
![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1)
|
|
|
|
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](https://appwrite.io/docs)
|
|
|
|
![Appwrite](https://appwrite.io/images/github.png)
|
|
|
|
## Installation
|
|
|
|
### NPM
|
|
|
|
To install via [NPM](https://www.npmjs.com/):
|
|
|
|
```bash
|
|
npm install appwrite --save
|
|
```
|
|
|
|
If you're using a bundler (like [Browserify](http://browserify.org/) or [webpack](https://webpack.js.org/)), you can import the Appwrite module when you need it:
|
|
|
|
```js
|
|
import * as Appwrite from "appwrite";
|
|
```
|
|
|
|
### CDN
|
|
|
|
To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
|
|
|
|
```html
|
|
<script src="https://cdn.jsdelivr.net/npm/appwrite@1.0.29"></script>
|
|
```
|
|
|
|
|
|
|
|
## Contribution
|
|
|
|
This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
|
|
|
|
## License
|
|
|
|
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information. |