# Agora RTT Web Demo

## Prepare

- node version 18+ , 20+

## Config

See [Get Started with Agora](https://docs.agora.io/en/video-calling/reference/manage-agora-account?platform=web#get-started-with-agora) to learn how to get an App ID and App Certificate. (Certificate must be turned on)

Activate RTM permissions in the console

<img src=https://fullapp.oss-cn-beijing.aliyuncs.com/pic/rtm/39351715138175_.pic.jpg width=80% />

Contact technical support to activate RTT permissions

- You can get help from intelligent customer service or contact sales staff [Agora support](https://agora-ticket.agora.io/)
- Send an email to [support@agora.io](mailto:support@agora.io) for consultation

Find `.env` file and fill in the following parameters correctly

```bash
VITE_AGORA_APP_ID=<YOUR_APP_ID>
VITE_AGORA_APP_CERTIFICATE=<YOUR_APP_CERTIFICATE>
```

## Install

In the project root path run the following command to install dependencies.

```bash
npm install
```

## Dev

Use the following command to run the sample project.

```bash
npm run dev
```

## Build

Use the following command to build the sample project.

```bash
npm run build
```

## SDK Development

This project includes plans for developing a reusable STT (Speech-to-Text) SDK based on the existing functionality.

### SDK Epic and Documentation

- **Epic Document**: [docs/prd/epic-1-stt-sdk.md](docs/prd/epic-1-stt-sdk.md) - Complete development epic for the STT SDK
- **API Specification**: [docs/prd/epic-1-stt-sdk-api-spec.md](docs/prd/epic-1-stt-sdk-api-spec.md) - Detailed API interface specifications
- **Architecture Design**: [docs/prd/epic-1-stt-sdk-architecture.md](docs/prd/epic-1-stt-sdk-architecture.md) - SDK architecture design
- **Package Structure**: [docs/prd/epic-1-stt-sdk-package-structure.md](docs/prd/epic-1-stt-sdk-package-structure.md) - Monorepo package structure

### SDK Features

The planned SDK will provide:

- Reusable STT and RTM manager functionality
- Universal TypeScript interfaces (framework-agnostic)
- Multi-language transcription and translation support
- Complete TypeScript type definitions
- Framework adapters (React, Vue, Angular) as optional packages
- Comprehensive documentation and examples

### Development Status

- [x] Epic planning and scope definition
- [x] API specification completed
- [x] Architecture design completed
- [x] Package structure designed
- [ ] Implementation (planned)
- [ ] Testing and validation
- [ ] Documentation and examples

For detailed development plans, please refer to the epic documentation.