56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# Appwrite SDK for JavaScript
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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.0"></script>
|
|
```
|
|
|
|
## 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
|
|
;
|
|
|
|
```
|
|
|
|
|
|
## 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. |