OfficeDev/generator-teams

Name: generator-teams

Owner: Office Developer

Description: A Yeoman Generator for Microsoft Teams

Created: 2017-03-03 10:24:18.0

Updated: 2018-05-03 18:41:18.0

Pushed: 2018-05-08 19:26:13.0

Homepage:

Size: 14386

Language: TypeScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

generator-teams

A Yeoman Generator for Microsoft Teams Apps.

This generator Generates a Microsoft Teams App that can be used to add Tabs, Bots, Connectors, Compose Extensions and more to Microsoft Teams based on Node.js and TypeScript.

npmjs

Note: The generator has been renamed from generator-teams-tab to generator-teams. Old package will be marked as deprecated.

yo teams Demo

Demo

Install

Important: If this is the first time you're using Yeoman or installing a Yeoman generator, first install Git and Node.js. For developers on Mac, we recommend using Node Version Manager to install Node.js with the right permissions. When the installation completes, restart your console (or if you are using Windows, restart your machine) to ensure you use the updated system environment variables.

Install yo (Yeoman) and generator-teams globally using NPM.

install yo generator-teams --global
Preview versions

Preview versions of the generator will be published with the preview tag and can be installed using the following command:

install yo --global
Install the preview generator

To install the preview version of the Teams generator, use the preview tag:

install generator-teams@preview --global
Usage
eams [arguments]

Note: Files are created in the directory that you run the command from hence make sure you are happy with the location before you hit enter.

Arguments

The following arguments can be used:

The generated project

When the generator is done you can start working with your project. Make sure to read the generated README.md file for more instructions. Depending on how you generate your project additional readme files might be created with further instructions.

Build the generator

If you are interested in contributing or modifying the generator itself, you clone this repository and then install all modules before building the solution.

install
run build

The bundled generator and the template files will end up in the ./generators/ folder.

Use it in dev mode

In the generator-teams directory use the following command, this will link the local copy of the folder as a global node module.

link

To revert the link operation:

unlink
More information

For more information on how Tabs and Bots can be used with Teams see the Teams Developer Documentation

Contributors
Contributing

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.