-
Notifications
You must be signed in to change notification settings - Fork 372
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
730c324
commit be6c1ad
Showing
1 changed file
with
37 additions
and
36 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,51 +1,52 @@ | ||
# Set up Bot Framework Composer using Yarn | ||
# Set up the Bot Framework Composer using Yarn | ||
|
||
Bot Framework Composer is designed to be a hosted web app. Currently, you need to run Composer locally as a web app and can do so using Yarn. | ||
In this article you will learn how to run the Bot Framework Composer as a hosted web app locally using Yarn. | ||
|
||
<!---To set up and install Composer with docker you can read more [here](link to docker setup).--> | ||
|
||
## Prerequisites | ||
|
||
- [Node.js](https://nodejs.org/dist/v12.13.0/): version 12.13.0 | ||
- [Yarn](https://yarnpkg.com/en/docs/install): latest stable version | ||
- [Bot Framework Emulator](https://github.com/microsoft/BotFramework-Emulator/releases/latest): latest stable version | ||
- [.NET Core SDK 2.2](https://dotnet.microsoft.com/download/dotnet-core/2.2): required to test your bot | ||
- [Node.js](https://nodejs.org/dist/v12.13.0/). Use version 12.13.0 or later. | ||
- The latest stable release of [Yarn](https://yarnpkg.com/en/docs/install). | ||
- The [Bot Framework Emulator](https://github.com/microsoft/BotFramework-Emulator/releases/latest). | ||
- You will need the [.NET Core SDK 2.2](https://dotnet.microsoft.com/download/dotnet-core/2.2) to test your bot. | ||
|
||
## Set up yarn for Composer | ||
To start, clone the Composer GitHub repository. | ||
``` | ||
git clone https://github.com/microsoft/BotFramework-Composer.git | ||
``` | ||
|
||
After cloning the repo open a terminal and navigate to the Bot Framework Composer folder. Run the following commands: | ||
``` | ||
cd Composer | ||
``` | ||
This command navigates to the **Composer** folder. | ||
1. To start, open a terminal and clone the Composer GitHub repository. You will use this terminal for the rest of the steps in this section. | ||
|
||
``` | ||
git clone https://github.com/microsoft/BotFramework-Composer.git | ||
``` | ||
|
||
2. After cloning the repository, navigate to the **Bot Framework Composer** folder and run the following commands to get all required packages: | ||
|
||
``` | ||
CD Composer | ||
yarn | ||
``` | ||
|
||
3. Next, run the following command to build the Composer application, this command can take several minutes to finish: | ||
|
||
``` | ||
yarn build | ||
``` | ||
|
||
``` | ||
yarn install | ||
``` | ||
This command installs all dependent packages. | ||
> [!NOTE] If you are having trouble installing or building Composer run `yarn tableflip`. This will remove all of the Composer application's dependencies (node_modules) and then it reinstalls and rebuilds all of its dependencies. Once completed, run `yarn install` and `yarn build` again. This process generally takes 5-10 minutes. | ||
4. Again using Yarn, start the Composer authoring application and the bot runtime: | ||
|
||
``` | ||
yarn startall | ||
``` | ||
|
||
``` | ||
yarn build | ||
``` | ||
This command builds the Composer app. The build process can take a few minutes. | ||
5. Once you see **Composer now running at:** appear in your terminal, you can run Composer in your browser using the address http://localhost:3000. | ||
|
||
> [!NOTE] | ||
> If you are having trouble intalling or building Composer run `yarn tableflip`, which removes all of the Composer application's dependencies (node_modules) and reinstalls and rebuilds the application's dependencies. After running `yarn tableflip` run `yarn install` and `yarn build` again. This process can take anywhere from 5-10 minutes. | ||
![browser address](./media/setup-yarn/address.png) | ||
|
||
After the Composer is built successfully you will see the message `Compiled successfully`. Run the last command: | ||
``` | ||
yarn startall | ||
``` | ||
This command starts the Composer authoring application and the bot runtime. | ||
Keep the terminal open as long as you plan to work with the Composer, as soon as you close it, Composer will stop running. | ||
|
||
## Open Composer in a browser | ||
After you run the last command `yarn startall`, you will see the address message as shown below. To use Composer open a browser and navigate to the address http://localhost:3000. | ||
The next time you need to run the Composer, all you will need to run `yarn startall` from the Composer directory. | ||
|
||
![browser address](./media/setup-yarn/address.png) | ||
## Next Steps | ||
|
||
## Next steps | ||
- Learn [how to create your first bot](tutorial-create-echobot.md). | ||
- Create a [echo bot](./tutorial-create-echobot.md) using Composer. |