scv-connector-base/README.md

Salesforce Service Cloud Connector Base

# Service Cloud Voice base connector
The base connector is an SDK for partner telephony systems that integrate with Salesforce Service Cloud Voice.

## Document
We’ve provided documentation in the `/docs` folder.

## Installation

### Environment setup
The developer environment requires [Node](https://nodejs.org/en/download/), [NPM](https://docs.npmjs.com/cli/install) and [webpack-dev-server](https://webpack.github.io/docs/webpack-dev-server.html). 


### Installation
#### Clone the repo
#### Install the dependencies

```
$ npm install
```

### Using it

See https://github.com/salesforce/demo-scv-connector

## Testing
Lint all the source code and run all the unit tests:
```
$ npm test
```

## Before creating a PR
Update the `scv-connector-base.js.map` and `scv-connector-base.js` files:
```
npm run gulp bundle
```
Add these files to the PR as well.

## Contributing and Developing Locally
We welcome contributors into our repo. Please read the [contributing guidelines](https://github.com/salesforce/scv-connector-base/blob/master/CONTRIBUTING.md) for more information.