documentation-bot

Description

A bot to retrieve documentation about any type of project (mostly software). This bot has been created using Bot Framework.

Requirements

• Node JS version 10.14.1 or higher.
• If you get an error related with "node-gyp" (a restify required package) in the installation step , you'll need to install some additional stuff depending on your OS. See node-gyp installation (the "node-gyp" package itself is not required to be installed manually since its a restify dependency).

Setup

1. Install the packages:

npm install

2. Run the project:

npm run start

or run the project to watch file changes:

npm run dev

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

• Install the Bot Framework Emulator version 4.9.0 or greater from here

Connect to the bot using Bot Framework Emulator

• Launch Bot Framework Emulator
• File -> Open Bot
• Enter a Bot URL of http://localhost:3978/api/messages

Deploy the bot to Azure

Publishing Changes to Azure Bot Service

# build the TypeScript bot before you publish
npm run build