-
Notifications
You must be signed in to change notification settings - Fork 281
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a57fecf
commit 63e9651
Showing
1 changed file
with
107 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,137 @@ | ||
|
|
||
| #  | ||
|
|
||
| ### [Click here to find out what's new with Bot Framework](https://github.com/Microsoft/botframework/blob/master/whats-new.md#whats-new) | ||
| This repository contains code for the JavaScript version of the [Microsoft Bot Framework SDK](https://github.com/Microsoft/botframework-sdk), which is part of the Microsoft Bot Framework - a comprehensive framework for building enterprise-grade conversational AI experiences. | ||
|
|
||
| # Bot Framework SDK v4 for JavaScript | ||
| This SDK enables developers to model conversation and build sophisticated bot applications using JavaScript. SDKs for [.NET](https://github.com/Microsoft/botbuilder-dotnet), [Python](https://github.com/Microsoft/botbuilder-python) and [Java (preview)](https://github.com/Microsoft/botbuilder-java) are also available. | ||
|
|
||
| This repository contains code for the JavaScript version of the Microsoft Bot Framework SDK. The Bot Framework SDK v4 enable developers to model conversation and build sophisticated bot applications. | ||
| To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0). If you are an existing user, then you can also [find out what's new with Bot Framework](https://docs.microsoft.com/en-us/azure/bot-service/what-is-new?view=azure-bot-service-4.0). | ||
|
|
||
| This repo is part the [Microsoft Bot Framework](https://github.com/microsoft/botframework) - a comprehensive framework for building enterprise-grade conversational AI experiences. | ||
| For more information jump to a section below. | ||
|
|
||
| * [Build status](#build-status) | ||
| * [Packages](#packages) | ||
| * [Getting started](#getting-started) | ||
| * [Getting support and providing feedback](#getting-support-and-providing-feedback) | ||
| * [Contributing and our code of conduct](#contributing-and-our-code-of-conduct) | ||
| * [Reporting security sssues](#reporting-security-issues) | ||
|
|
||
| ## Build Status | ||
|
|
||
| | Branch | Description | Build Status | Coverage Status | Windows Bot Test Status | Linux Bot Test Status |Browser Functional Tests | ||
| |----|---------------|--------------|-----------------|--|--|--| | ||
| |Master | 4.10.* Preview Builds |[](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=460)|[](https://coveralls.io/github/microsoft/botbuilder-js?branch=master)|[](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=548&branchName=master)|[](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=549&branchName=master)|[](https://fuselabs.visualstudio.com/SDK_v4/_build/latest?definitionId=731&branchName=master) | ||
|
|
||
| [](https://github.com/Microsoft/botbuilder-js/blob/master/LICENSE) | ||
| [](https://gitter.im/Microsoft/BotBuilder) | ||
| ## Packages | ||
|
|
||
| [](https://stackoverflow.com/questions/tagged/botframework) | ||
| | Name | NPM Package | | ||
| |---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | adaptive-expressions | [](https://www.npmjs.com/package/adaptive-expressions/) | | ||
| | botbuilder | [](https://www.npmjs.com/package/botbuilder/) | | ||
| | botbuilder-ai | [](https://www.npmjs.com/package/botbuilder-ai/) | | ||
| | botbuilder-applicationinsights | [](https://www.npmjs.com/package/botbuilder-applicationinsights/) | | ||
| | botbuilder-azure | [](https://www.npmjs.com/package/botbuilder-azure/) | | ||
| | botbuilder-core | [](https://www.npmjs.com/package/botbuilder-core/) | | ||
| | botbuilder-dialogs | [](https://www.npmjs.com/package/botbuilder-dialogs/) | | ||
| | botbuilder-dialogs-adaptive | [](https://www.npmjs.com/package/botbuilder-dialogs-adaptive/) | | ||
| | botbuilder-dialogs-declarative | [](https://www.npmjs.com/package/botbuilder-dialogs-declarative/) | | ||
| | botbuilder-lg | [](https://www.npmjs.com/package/botbuilder-lg/) | | ||
| | botbuilder-testing | [](https://www.npmjs.com/package/botbuilder-testing/) | | ||
| | botframework-config | [](https://www.npmjs.com/package/botframework-config/) | | ||
| | botframework-connector | [](https://www.npmjs.com/package/botframework-connector/) | | ||
| | botframework-schema | [](https://www.npmjs.com/package/botframework-schema/) | | ||
| | botframework-streaming | [](https://www.npmjs.com/package/botframework-streaming/) | | ||
|
|
||
| In addition to the JavaScript SDK, Bot Builder supports creating bots in other popular programming languages like [.NET](https://github.com/Microsoft/botbuilder-dotnet), [Python](https://github.com/Microsoft/botbuilder-python), and [Java](https://github.com/Microsoft/botbuilder-java). | ||
| ## Getting Started | ||
| To get started building bots using the SDK, see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0). | ||
|
|
||
| To get started see the [Azure Bot Service Documentation](https://docs.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0) for the v4 SDK. | ||
| The [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) includes a rich set of samples repository. | ||
|
|
||
| A rich set of samples are available at [Bot Framework Samples](https://github.com/microsoft/botbuilder-samples) repository. | ||
| If you want to debug an issue, would like to [contribute](#contributing), or understand how the Bot Builder SDK works, instructions for building and testing the SDK are below. | ||
|
|
||
| ### Prerequisites | ||
| - [Git](https://git-scm.com/downloads) | ||
| - [Node.js](https://nodejs.org/en/) | ||
| - [Lerna](https://lernajs.io/) | ||
| - [Nyc](https://www.npmjs.com/package/nyc) | ||
| - [Mocha](https://www.npmjs.com/package/mocha) | ||
| - [TypeScript](https://www.typescriptlang.org/) | ||
| - Your favorite code-editor for example [VS Code](https://code.visualstudio.com/) | ||
|
|
||
| ## Packages | ||
| | Name | Released Package | Daily Build | | ||
| |---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| | ||
| | botbuilder | [](https://www.npmjs.com/package/botbuilder/) | TBD | | ||
| | botbuilder-ai | [](https://www.npmjs.com/package/botbuilder-ai/) | TBD | | ||
| | botbuilder-applicationinsights | [](https://www.npmjs.com/package/botbuilder-applicationinsights/) | TBD | | ||
| | botbuilder-azure | [](https://www.npmjs.com/package/botbuilder-azure/) | TBD | | ||
| | botbuilder-core | [](https://www.npmjs.com/package/botbuilder-core/) | TBD | | ||
| | botbuilder-dialogs | [](https://www.npmjs.com/package/botbuilder-dialogs/) | TBD | | ||
| | botframework-config | [](https://www.npmjs.com/package/botframework-config/) | TBD | | ||
| | botframework-connector | [](https://www.npmjs.com/package/botframework-connector/) | TBD | | ||
| | botframework-schema | [](https://www.npmjs.com/package/botframework-schema/) | TBD | | ||
| ### Clone | ||
| Clone a copy of the repo: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Microsoft/botbuilder-js.git | ||
| ``` | ||
|
|
||
| To use the daily builds, which are published to MyGet, please follow the instructions [here](UsingMyGet.md). | ||
| Change to the SDK's directory: | ||
|
|
||
| ```bash | ||
| cd botbuilder-js | ||
| ``` | ||
|
|
||
| ### Build and test locally | ||
| Install the prerequisites. This will also run the postinstall script (`lerna bootstrap --hoist`). | ||
|
|
||
| ## Contributing | ||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
| Then use the following command to build the SDK. | ||
|
|
||
| When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
| a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
| provided by the bot. You will only need to do this once across all repos using our CLA. | ||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
| ### Running unit tests | ||
|
|
||
| See our [Contribution Guidelines](https://github.com/Microsoft/botbuilder-js/wiki/Contribution-Guidelines) for more details. | ||
| Use the following command to run the unit tests. | ||
|
|
||
| ## Reporting Security Issues | ||
| ```bash | ||
| npm run test | ||
| ``` | ||
|
|
||
| The `prep-test.cmd` command is run to install test keys and start the [Azure Storage Emulator](https://docs.microsoft.com/en-us/azure/storage/common/storage-use-emulator) if its installed. Any unit tests needing test keys or the storage emulator are designed to be skipped if their dependencies are missing so most developers won't need to worry about running this command. | ||
|
|
||
| If you have a need to re-generate the LUIS or connector clients using the latest swagger you'll need to install `autorest` (requires Node 7.10.0 or higher), which you can do with the following command. | ||
|
|
||
| ```bash | ||
| npm install --global autorest | ||
| ``` | ||
|
|
||
| ## Getting support and providing feedback | ||
| Below are the various channels that are available to you for obtaining support and providing feedback. Please pay carful attention to which channel should be used for which type of content. e.g. general "how do I..." questions should be asked on Stack Overflow, Twitter or Gitter, with GitHub issues being for feature requests and bug reports. | ||
|
|
||
| Security issues and bugs should be reported privately, via email, to the Microsoft Security | ||
| Response Center (MSRC) at [[email protected]](mailto:[email protected]). You should | ||
| receive a response within 24 hours. If for some reason you do not, please follow up via | ||
| email to ensure we received your original message. Further information, including the | ||
| [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in | ||
| the [Security TechCenter](https://technet.microsoft.com/en-us/security/default). | ||
| ### Github issues | ||
| [Github issues](https://github.com/Microsoft/botbuilder-python/issues) should be used for bugs and feature requests. | ||
|
|
||
| ### Stack overflow | ||
| [Stack Overflow](https://stackoverflow.com/questions/tagged/botframework) is a great place for getting high-quality answers. Our support team, as well as many of our community members are already on Stack Overflow providing answers to 'how-to' questions. | ||
|
|
||
| ### Azure Support | ||
| If you issues relates to [Azure Bot Service](https://azure.microsoft.com/en-gb/services/bot-service/), you can take advantage of the available [Azure support options](https://azure.microsoft.com/en-us/support/options/). | ||
|
|
||
| We use the [@botframework](https://twitter.com/botframework) account on twitter for announcements and members from the development team watch for tweets for @botframework. | ||
|
|
||
| ### Gitter Chat Room | ||
| The [Gitter Channel](https://gitter.im/Microsoft/BotBuilder) provides a place where the Community can get together and collaborate. | ||
|
|
||
| ## Contributing and our code of conduct | ||
| We welcome contributions and suggestions. Please see our [contributing guidelines](./contributing.md) for more information. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact | ||
| [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| ## Reporting Security Issues | ||
| Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) | ||
| at [[email protected]](mailto:[email protected]). You should receive a response within 24 hours. If for some | ||
| reason you do not, please follow up via email to ensure we received your original message. Further information, | ||
| including the [MSRC PGP](https://technet.microsoft.com/en-us/security/dn606155) key, can be found in the | ||
| [Security TechCenter](https://technet.microsoft.com/en-us/security/default). | ||
|
|
||
| Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
|
||
| Licensed under the [MIT](./LICENSE.md) License. |