Share via


Bot Framework Composer: Getting started

Introduction

Bot Framework Composer is a fantastic tool for creating/developing Microsoft bots, as it gives you the ability to sketch out and compose the whole simple and complex Bot applications within a visual interface instead of writing actual code. Composer to create the bot solution’s code and run it immediately to test it in the emulator and deploy it to Azure using the CLI. Bot developer should definitely check out this really awesome tool as this will be making your Bot development even easier in terms of building smart and engaging bots with ease. you want to learn more, just read this article for understanding and setup Bot Framework composer.

   

Setup Bot Framework Composer 

The Microsoft Bot Framework Composer is a Microsoft open source GitHub project, you can clone the source code and start contributing to the development as well. It’s a web-based application, you can download and run the web application in local machine.

 

Run Bot Composer web application

You can wait some time for clone the source code, after cloning the repo open a commend prompt and navigate to the Bot Framework Composer folder and run the following commands for start the web application.

Install Yarn

Build and Run the Composer application yarn software is required.  Yarn is a package manager for code. It allows you to use and share code with other developers from around the world. 

Install Node JS 

Node JS is required for setup the application, download and install the Node JS application.  

 

Install .Net Core SDK

Build and test application required Dot net core SDK, Install Dotnet core 2.2++

Install Bot Emulator 

Download and install Bot emulator for test the application

Build and Run Bot Composer

You can successfully install and all required software, let we start build and test the composer. Open Command prompt and switch to “Composer” folder using cd** <folder path>/Composer**

Install Dependencies

Install all the dependencies using “yarn install “ in command prompt

Build composer 

creating and optimized production build extensions and library using “**yarn build **“ in command prompt.

Start Web Composer

Start the client and server using “yarn startall” in command prompt.

Composer Home page 

Bot framework Composer hosted successfully, open a browser and navigate to the address(http://localhost:3000) after the message composer running successfully.

Create New Bot Composer Project 

You can create new project or Microsoft provided example template with best practices and supporting components. Let we continue and select existing composer template for demo.

New Project 

Click on New or Select Example template and provide the Solutions Location, name and project description and start do the Visual design.

Visual Design

Start look the visual design and no need to design for now and next article will explain very detail to How to manage and design and modify visual design

Start Bot

Click on “Start Bot”, it will take some time to build the solutions.

Test in Bot Emulator 

You're now ready to start and test your bot. You will then see the Test in Emulator button show up. Click Test in Emulator and Bot Framework Emulator should start.

How to resolve Build issue

You can easily resolve your build problem, if you are getting error “You intended to execute a .NET Core program, but dotnet-bin/Debug/netcoreapp2.1/BotProject.dll does not exist. * You intended to run a global tool, but a dotnet-prefixed executable with this name could not be found on the PATH.”, the output solution not able to compile.

  1. Go the location of your generated bot (The one you set when creating a new bot, defaults to User Documents > Composer).  
  2. Open command prompt “Run dotnet” build in your bot directory and see the errors.
  3. If you have visual studio, you can ignore step 2 and Open your project in Visual Studio.
  4. The issue maybe ranges of sources for the build not to run. Wrongly configured Nuget sources, misaligned package version, just check and resolve yourself.
  5. Once the build succeeds, launching the bot via Composer again.

Summary

You have successfully done the setup and build bot application in Bot framework composer. I hope you have enjoyed learning. If you have any questions/feedback/issues, please write them in the comment box.

References