# Javascript Development Kit
## Installation
#### NPM
Run this command:
```sh
npm install comfortable-javascript
```
#### For usage in the Browser
```html
```
> **Note:** For a specific version replace ```@latest``` with the version of your choice.
The SDK will be available as a global variable called: ```Comfortable```
#### Downloadable version
Check out our release Page: https://github.com/cmftable/comfortable-javascript/releases
### Include the dependency:
```javascript
const Comfortable = require('comfortable-javascript');
```
### Connect to your Repository and make your first request:
```javascript
const api = Comfortable.api('{repository-api-id}', '{api-key}', options);
api.getDocuments()
.then(result => {
// futher implementation
})
.catch(err => {
throw err;
})
```
Complete documentation, installation instructions, and examples are available [here](https://docs.comfortable.io/sdks/javascript).
### Options:
| Option | Type | Description |
|----------|---------|-------------------------------------------------------------------------------|
| useProxy | boolean | enables the usage of a Proxy Endpoint instead of using https://api.cmft.io/v1 |
| proxy | string | Proxy Url e.g. https://custom-api.com/v1 |
## Tests
1. npm is a prerequisite for running the tests. Install npm on your system, then run ```npm install``` to install required files.
2. Edit ```tests/Api.ts``` to add your credentials and test documents. Alternatively you can set your credentials as environment variables. For this you have to define `CMFT_REPOSITORY`, `CMFT_APIKEY`, `CMFT_DOCUMENT_ID`, `CMFT_DOCUMENT_ALIAS`. `CMFT_ASSET_ID`. `CMFT_PROXY_URL`.
3. The tests can be executed by running the following command from the root directory:
```javascript
npm run test
// or
CMFT_REPOSITORY=... CMFT_APIKEY=... CMFT_DOCUMENT_ID=... CMFT_DOCUMENT_ALIAS=... CMFT_ASSET_ID=... CMFT_PROXY_URL=... npm run test
```
## More information
- [Developer Documentation](https://docs.comfortable.io)
- [Javascript SDK Documentation](https://docs.comfortable.io/sdks/javascript)
- [Changelog](https://github.com/cmftable/comfortable-javascript/releases)
## Contributing
Pull requests are always welcome!
[](http://makeapullrequest.com)
## License
This repository is published under the [MIT](LICENSE) license.