1
0
Fork 0
mirror of synced 2024-07-16 03:46:02 +12:00
appwrite/app/sdks/web-javascript/README.md

59 lines
2.1 KiB
Markdown
Raw Normal View History

2020-01-28 10:50:41 +13:00
# Appwrite SDK for JavaScript
2020-01-31 13:14:47 +13:00
![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1)
2020-05-17 17:29:57 +12:00
![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1)
2020-01-28 10:50:41 +13:00
2020-05-02 16:23:56 +12:00
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.
2020-05-17 18:47:01 +12:00
Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
2020-05-02 16:23:56 +12:00
For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
2020-05-01 07:16:14 +12:00
2020-01-28 10:50:41 +13:00
![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
2020-03-20 05:46:30 +13:00
<script src="https://cdn.jsdelivr.net/npm/appwrite@1.0.29"></script>
2020-01-28 10:50:41 +13:00
```
2020-04-06 08:39:45 +12:00
## Getting Started
Initialise the Appwrite SDK in your code, and setup your API credentials:
```js
// Init your JS SDK
var appwrite = new Appwrite();
appwrite
.setEndpoint('http://localhost/v1') // Set only when using self-hosted solution
.setProject('455x34dfkj') // Your Appwrite Project UID
;
```
2020-01-28 10:50:41 +13:00
2020-03-27 02:20:07 +13:00
## 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.
2020-01-28 10:50:41 +13:00
## License
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.