communication-ui-library/README.md

# Azure Communication Services UI Toolkit

[![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg)](https://azure.github.io/communication-ui-sdk)
[![CI build status](https://github.com/Azure/communication-ui-sdk/workflows/CI/badge.svg?branch=main)](https://github.com/Azure/communication-ui-sdk/actions/workflows/ci.yml?query=branch%3Amain)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)

Azure Communication Services UI toolkit is a collection of JavaScript libraries that can be used to easily build fast, responsive communication web applications.

We also have a number of samples to try out features and get your development kick started 🚀

## Getting Started

If you're wondering where to get started, here are a few scenarios to help you get going:

* "I want to see what this library can do!"
  * Check out our [Samples](#samples), our [Storybook](https://azure.github.io/communication-ui-sdk), and read more about the [features and benefits](#features-and-benefits) of the toolkit
* "I want to write my own communication application"
  * We recommend checking out our more comprehensive documentation here first to make the best decision for your application: <https://docs.microsoft.com/en-us/azure/communication-services/concepts/ui-framework/ui-sdk-overview>
* "I want more information on the packages available to use"
  * Check out the [packages](#packages) on offer
* "I want to submit a fix for a package in this repo"
  * Check out our [making a contribution](<./docs/contributing-guide/1. getting-set-up.md>) guide

## Samples

Check out our samples or deploy your own version of the sample to see how easy it is to get started.

Sample | Description | Deploy to Azure | Run locally
------ | ----------- | ------ | ---------- |
Chat | A group chat application you can invite your friends and colleagues to. | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fcommunication-services-web-calling-hero%2Fmain%2Fdeploy%2Fazuredeploy.json) | [Chat instructions](./samples/Chat/README.md)
Group Call | A group calling application you can invite your friends and colleagues to. | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fcommunication-services-web-calling-hero%2Fmain%2Fdeploy%2Fazuredeploy.json) | [Calling instructions](./samples/Calling/README.md)
One to One Call | A one-to-one calling application where you can make a direct call to a friend or colleague. | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fcommunication-services-web-calling-hero%2Fmain%2Fdeploy%2Fazuredeploy.json) | [One-To-One Call instructions](./samples/OneToOne/README.md)

## Features and Benefits

Todo: _Why use our toolkit?_

### Viewing the UI Component Storybook

Explore and play around with the UI components on the [![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg)](https://azure.github.io/communication-ui-sdk)

## Packages

Package | Description | License | Latest Version
------- | ----------- | ------- | --------------
[`react-components`](packages/react-components/README.md) | Todo: _Package description_ | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | [![react-components npm version](https://badge.fury.io/js/UPDATE-WHEN-RELEASED.svg)](https://www.npmjs.com/)
[`@Azure/acs-calling-declarative`](packages/acs-calling-declarative/README.md) | Todo: _Package description_ | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | [![react-components npm version](https://badge.fury.io/js/UPDATE-WHEN-RELEASED.svg)](https://www.npmjs.com/)
[`@Azure/acs-calling-selector`](packages/acs-calling-selector/README.md) | Todo: _Package description_ | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | [![react-components npm version](https://badge.fury.io/js/UPDATE-WHEN-RELEASED.svg)](https://www.npmjs.com/)
[`@Azure/acs-chat-declarative`](packages/acs-chat-declarative/README.md) | Todo: _Package description_ | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | [![react-components npm version](https://badge.fury.io/js/UPDATE-WHEN-RELEASED.svg)](https://www.npmjs.com/)
[`@Azure/acs-chat-selector`](packages/acs-chat-selector/README.md) | Todo: _Package description_ | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | [![react-components npm version](https://badge.fury.io/js/UPDATE-WHEN-RELEASED.svg)](https://www.npmjs.com/)

## Contributing to the Packages or Samples

Join us by making a contribution. To get you started check out our [making a contribution](<./docs/contributing-guide/1. getting-set-up.md>) guide.

We look forward to building an amazing open source toolkit with you!

## Further Reading

* [Repo Documentation](./docs/README.md)
* [Conceptual Documentation](https://docs.microsoft.com/en-us/azure/communication-services/concepts/ui-framework/ui-sdk-overview)
* [Quick-start Documentation](https://azure.github.io/communication-ui-sdk/?path=/story/quickstart-ui-components--page)