classicvalues/microsoft-teams-library-js

JavaScript library for use by Microsoft Teams apps

Microsoft Teams JavaScript client SDK

Welcome to the Teams client SDK monorepo! For breaking changes, please refer to our changelog in the <root>/packages/teams-js directory. This repository contains the core teams-js package as well as tools and applications for analyzing and testing.

Getting Started

1. Clone the repo
2. Run yarn install from repo root
3. Run yarn build from repo root
4. To run Unit tests, run yarn test

TIP: whenever building or testing the Teams client SDK, you can run yarn build or yarn test from the packages/teams-js directory.

See also: Contributing

This JavaScript library is part of the Microsoft Teams developer platform. See full SDK reference documentation.

Packages

Contain the core exports for the repository.

teams-js

Used to integrate custom services and applications with Teams, Outlook, and Office.

---

Apps

The apps folder contains applications used to test various aspects of the SDK.

Teams Perf Test App

React application used to locally test the loading times of the SDK.

Teams Test App

Application used to test the functionality of the various SDK APIs.

---

Locally generating reference documentation

If you would like to locally generate reference documentation for TeamsJS v2, simply utilize the script yarn docs either from the monorepo root or inside the teams-js project root (packages/teams-js). This should output the generated documentation to packages/teams-js/docs.

Contributing

We strongly welcome and encourage contributions to this project. Please read the contributor's guide which contains important information.

---

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.