Skip to content

Latest commit

 

History

History
executable file
·
77 lines (60 loc) · 2.54 KB

README.md

File metadata and controls

executable file
·
77 lines (60 loc) · 2.54 KB
Raw

AvaBot Deployment Manual

AvaBot has been created using MS Bot Framework, it can

  • Answer general questions, Avanade-related questions, and UCL-related questions
  • Summarize a document
  • Extract table data from a document
  • Answer questions about a document
  • Recognize images of business-card pattern

Prerequisites

Build and Run

Configure Bot Framework Emulator

  • Install the latest Bot Framework Emulator from here
  • Launch Bot Framework Emulator
  • Go to Settings on the left bottom of the window
  • Enter Path of ngrok
  • Tick Bypass ngrok for local address box
  • Tick Run ngrok when the Emulator starts up box

Run the bot

  • Clone the repository

    git clone https://github.com/UCLComputerScience/COMP0016_2020_21_Team8.git

  • Make sure MicrosoftAppId, MicrosoftAppPassword, QnAKnowledgebaseId, QnAEndpointKey, and QnAEndpointHostName are correctly configured in AvabotTeam8-src/.env file

  • In a terminal, navigate to AvabotTeam8-src

    cd AvabotTeam8-src

  • Install modules

    npm install

  • Run the bot

    npm start

  • Launch Bot Framework Emulator

  • File -> Open Bot

  • Browse and choose AvaBot.bot in the COMP0016_2020_21_Team8 repository

Test

The testing of the project uses mocha, chai, and MS botbuilder-testing package. Make sure you have installed them by npm install.

  • In a terminal, navigate to AvabotTeam8-src
  • Run test by 
    npm run test
  • Run test with coverage by 
    npm run cover
  • Run test and generate a coverage report by 
    npm run coverage

Note: for passing all the tests, make sure the APIs used by the bot are working properly.

Further Development

To develop your own bot application, see Azure Bot Service for creating Web App Bot resource and configure the AvabotTeam8-src/.env file with your AppId and AppPassword.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.