generator-AdaptiveCardTransformer

Yeoman generator for the adaptive-card-transformer. This generator will let you quickly set up an echo bot and plugins for use with the adaptive-card-transformer.

About

To use the adaptive-card-transformer, you will need a bot and plugins. If you do not already have a bot, you can create a new echo bot with the generator-AdaptiveCardTransformer. After scaffolding the echo bot and selected plugins, the generator will prompt the user to integrate the adaptive-card-transformer and plugins into the provided echo bot. If you already have a bot, you will need to manually integrate the adaptive-card-transformer and plugins into your bot. For manual integration, please refer to this documentation

Related Projects

There are three related repositories for the Adaptive Card Transformer:

• AdaptiveCardTransformer - The easy-to-use adapter enabling back-end NLU responses to be rendered through Adaptive Card functionality with an extendable plugin pattern
• AdaptiveCardTransformerExampleBot - The Teams bot example implementation that uses the adaptive-card-transformer
• generator-AdaptiveCardTransformer (this repository) - The Yeoman generator for scaffolding plugins using the adaptive-card-transoformer

Installation

First, install Yeoman and generator-adaptive-card-transformer using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g @retaildevcrews/generator-adaptive-card-transformer

Then generate your new project:

yo @retaildevcrews/adaptive-card-transformer

Local Installation (for development)

To run build and run the generator locally, you have to be in the generator-adaptive-card-transformer directory. From the root run the following commands:

npm install -g yo    // installs yeoman globally - needed to run the generator
npm install          // installs generator source dependencies
npm link             // creates a local package of the adaptive-card-transformer generator

Navigate to the directory where you want to use the adaptive-card-transformer and run:

yo @retaildevcrews/adaptive-card-transformer     // files will be generated in your current directory

Run your scaffolded bot and plugins

If you selected to create an echo bot with your plugins, you can run your project locally after the Yeoman generator completes.

1. Open .npmrc in your project's root directory

   • Replace TOKEN in .npmrc with your own created token:

   //npm.pkg.github.com/:_authToken=TOKEN
   @retaildevcrews:registry=https://npm.pkg.github.com

2. Run npm install to ensure the adaptive-card-transformer was installed

3. Run npm start

4. Launch Bot Framework Emulator

   • File -> Open Bot
   • Enter a Bot URL of http://localhost:3978/api/messages
   • Once the Emulator is connected, you can interact with and receive messages from your bot.

How to file issues and get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. For help and questions about using this project, please open a GitHub issue.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.