blank/README.md

Agora RTT Web Demo

Prepare

• node version 18+ , 20+

Config

See 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

Contact technical support to activate RTT permissions

• You can get help from intelligent customer service or contact sales staff Agora support
• Send an email to support@agora.io for consultation

Find .env file and fill in the following parameters correctly

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.

npm install

Dev

Use the following command to run the sample project.

npm run dev

Build

Use the following command to build the sample project.

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 - Complete development epic for the STT SDK
• API Specification: docs/prd/epic-1-stt-sdk-api-spec.md - Detailed API interface specifications
• Architecture Design: docs/prd/epic-1-stt-sdk-architecture.md - SDK architecture design
• Package Structure: 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

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

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