@kaltura-ng/kaltura-client/README.md

Kaltura Typescript client

# Kaltura Typescript Client

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![Gitter chat](https://badges.gitter.im/kaltura-ng/kaltura-ng.png)](https://gitter.im/kaltura-ng/kaltura-ng)

> An easy-to-use facade to Kaltura server with typescript support for action requests, classes and enums.

This library uses `Typescript` files that are transpiled  into `ECMAScript 5` using `commonjs` as a module system.

This library have **_zero dependencies_** at runtime and it can be used in any Javascript project. Those who are using Typescript will benefit even more.

 >Visit our [live demonstration](https://goo.gl/c02JX2) for code snippets and common use cases.

## Installation

use 'npm' to get the library
```bash
$ npm install @kaltura-ng/kaltura-client
```

## Instructions

### Getting Started
To keep being update review the [changelog](CHANGELOG.md) frequently.

 **Have a question?** Ask us on [Gitter](https://gitter.im/kaltura-ng/kaltura-ng).

 **Found a bug?** create [github issue](https://github.com/kaltura/KalturaGeneratedAPIClientsTypescript/issues)



## Features list
View list of features [here](features.md).

# Building the sources
> This library is auto-generated using `kaltura/clients-generator` php engine. Feel free to clone, build and play with this library but in order to submit PR you should work against the [kaltura/clients-generator](https://github.com/kaltura/clients-generator) repo.


## Building the client library
After cloning the repo you should install dependent libraries:
```bash
$ npm install
$ npm run build
```

## Running integration tests
- In `src/tests` folder you should duplicate file `tests-config.template.ts` and name it `tests-config.ts`.
- Modify the file content to include valid information.
- Run `npm run test` to test the library

> If you want to test the library against the production server use the following as the endpoint in the config file: http://www.kaltura.com/api_v3/index.php/


## License and Copyright Information
All code in this project is released under the [AGPLv3 license](http://www.gnu.org/licenses/agpl-3.0.html) unless a different license for a particular library is specified in the applicable library path.

Copyright © Kaltura Inc. All rights reserved.