BF-template
Project Summary
This is a template for building a monorepo of resources for Bot Framework bot development and deployment.
This project contains multiple parts. Please see the descriptions below for an understanding of the overall project. Package README.md
files contain more information pertaining to that particular package.
bot
package:- Provides basic bot setup information
TemplateBot.ts
is a basic echo bot, which iterates on the BotBuilder TypeScript Samples- Provides a jumpstart bot to speed up development
index.ts
is the basic server setup for running the bot
bot-offline
package:- Provides browser bot setup information
createDirectLine.js
is a custom Bot Adapter that is hosted in the browser. This creates a customWebChatAdapter
to:- Offload server behavior onto client machine
- Reduce latency - very helpful for testing non-production bots
- This package can use
TemplateBot.ts
frombot/
to jumpstart development
commands
package:- Commands intended for both hosted and browser bots are saved here
- This allows for DRY bot production where commands for multiple bots don't need to be written multiple times
legacy/
contains deprecated code from BotFramework MockBot, which need to be migrated tosrc/
src/
contains updated commands for testing bot features
- Commands intended for both hosted and browser bots are saved here
token-server
package:
* These services have not yet been implemented into the project
Not sure where to start?
Basic deployment will need the bot and token server, so check those packages first.
Setup
- Create a repository from this template
- Set up the bot and token server
- Developers using this template will most likely want to start with the
bot/
andtoken-server/
packages. - See the individual package
README.md
for detailed setup instructions
- Developers using this template will most likely want to start with the