https://github.com/compulim/botframework-directlinejs-speech

https://github.com/compulim/botframework-directlinejs-speech

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/compulim/botframework-directlinejs-speech
• Owner: compulim
• Created: 2019-09-24T17:37:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T11:17:39.000Z (over 2 years ago)
• Last Synced: 2025-05-15T18:13:24.748Z (4 days ago)
• Language: JavaScript
• Size: 24.4 MB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DirectLineJS for Direct Line Speech channel

[![Build Status](https://travis-ci.org/compulim/botframework-directlinejs-speech.svg?branch=master)](https://travis-ci.org/compulim/botframework-directlinejs-speech)

## Hosted demo

To try out the demo, navigate to https://compulim.github.io/botframework-directlinejs-speech/?s=DIRECT_LINE_SECRET&sr=SPEECH_SERVICES_REGION&ss=SPEECH_SERVICES_SUBSCRIPTION_KEY.

The demo page is connected to a bot codenamed "Waterbottle", source code at [compulim/botframework-waterbottle](https://github.com/compulim/botframework-waterbottle).

The build drops can be found on [this release page](https://github.com/compulim/botframework-directlinejs-speech/releases/tag/dev):

- `botframework-directlinejs-speech-*.tgz` is the tarball as if we would publish it

- [`botframework-directlinejs-speech.tgz`](https://github.com/compulim/botframework-directlinejs-speech/releases/download/dev/botframework-directlinejs-speech.tgz) is the latest tarball

- `directlinespeech-*.js` is the bundle to be used in browser, under `window.DirectLineSpeech`

- [`directlinespeech.js`](https://github.com/compulim/botframework-directlinejs-speech/releases/download/dev/directlinespeech.js) is the latest bundle

## How to contribute

This repository has [Travis CI configured for CI/CD](https://travis-ci.org/compulim/botframework-directlinejs-speech). When a commit is pushed, it will automatically deploy to the demo page. It should complete the whole process within 5 minutes.

### Bumping Speech SDK version

1. Clone the source code

1. Run `npm ci`

1. Drop the tarball under `/external/` folder

1. Run `npm install external/microsoft-cognitiveservices-speech-sdk-1.6.0-alpha.0.1.tgz`

   - This will update `package-lock.json`

1. Push a commit

1. Wait until Travis CI completely built it

   - Build status at https://travis-ci.org/compulim/botframework-directlinejs-speech

1. Try out the demo at https://compulim.github.io/botframework-directlinejs-speech/

> Note: GitHub Pages limit to 10 deployments per hour

#### Updating Speech SDK package name

If you do need to modify the package name, don't modify `package.json` by hand, do the followings instead:

1. `npm uninstall microsoft-cognitiveservices-speech-sdk`

1. `npm install external/your-new-package.tgz`

1. You may need to modify `/src/index.js` to reference the new package

### Modifying DirectLineJS source code

1. Clone the repository

1. `npm ci`

1. `npm start`

1. Start modifying `/src/index.js`

   - When you save the file, make sure Babel and Webpack both compile successfully

1. Navigate to http://localhost:5000/

### Modifying the bot

Please submit a ticket to either repository and drop me a message.

The bot is part of a test harness. Modifying it may break a lot of tests.

### Using it in your own web app

```html

  

    

    

  

  

    


    

      window.WebChat.renderWebChat({

        directLine: new window.DirectLineSpeech.DirectLine({

          token: '...'

        })

      }, document.getElementById('webchat'));

    

  


```

## Questions

### How can I use Direct Line token as the credentials?