Skip to content

index.en.md

Latest commit

 

History

History
125 lines (96 loc) · 4.48 KB

index.en.md

File metadata and controls

125 lines (96 loc) · 4.48 KB

Introduction

This document presents the repository structure, package description, examples, and FAQs.

Repository Structure

This repository is a multi-package repository that includes uikit, callkit, roomkit, and corresponding example projects.

Currently, mainstream projects adopt this repository structure, for example, react-navigation, sendbird-uikit-react-native, and stream-chat-react-native. If you are interested, you can click the links in the reference section for further details.

Repository structure

.
├── LICENSE
├── docs
│   └── v4
├── examples
│   ├── room-example
│   ├── product-room-demo
│   ├── product-uikit-demo
│   ├── callkit-example
│   └── uikit-example
├── node_modules
├── package.json
├── packages
│   ├── react-native-chat-room
│   ├── react-native-chat-callkit
│   └── react-native-chat-uikit
├── patches
├── res
├── scripts
├── templates
├── tsconfig.json
└── yarn.lock

Structural Description

  • LICENSE: license file
  • docs: a compilation of documents, currently in the latest V3 version.
  • example: complete sample project, dependent on local npm packages. Currently, callkit and uikit are used.
  • examples:
    • room-example: sample project of the room package.
    • product-room-demo: Sample demonstration project of the product-room SDK.
    • product-uikit-demo: Sample demonstration project of the product-uikit SDK.
    • callkit-example: sample project of the callkit package.
    • uikit-example: sample project of the uikit package.
  • node_modules: list of project dependencies managed by the yarn tool.
  • package.json: project configuration file. It is the core configuration of this repository. The package.json files in other subfolders are responsible for managing sub-projects.
  • packages:
    • react-native-chat-room: room SDK。
    • react-native-chat-callkit: callkit SDK.
    • react-native-chat-uikit: uikit SDK.
  • patches: Patches for fixing urgent issues.
  • res: Resource folder.
  • scripts: Script folder.
  • templates: Template folder.
  • tsconfig.json: Configuration for TypeScript language.
  • yarn.lock: version management file for project dependencies configuration.

Package

The packages folder include react-native-chat-callkit and react-native-chat-uikit packages. There may be additional packages in the future according to requirements.

  • react-native-chat-room: Primarily assists users in integrating chatroom functionalities.
  • react-native-chat-callkit: Primarily assists users in integrating audio and video call functionalities.
  • react-native-chat-uikit: Primarily assists users in integrating react-native-chat-sdk functionalities. If you are interested, you can click the links in the reference section for further details.

Callkit SDK Documentation Entry
UIkit SDK Documentation Entry room uikit SDK Documentation Entry

Examples

The examples folder mainly includes a list of sample projects.

callkit-example: Mainly demonstrates the usage of the callkit SDK. uikit-example: Mainly demonstrates the usage of the uikit SDK. room-example: Mainly demonstrates the usage of the room SDK. product-uikit-demo: Comprehensively demonstrates the usage of uikit + callkit SDKs. product-room-demo: Comprehensively demonstrates the usage of the room SDK.

Room Quick Start Guide UIKit Quick Start Guide CallKit Quick Start Guide

Build a Repository

See Build a Repository.

Create a Repository

See Create a Repository.

Route

See Route.

Contents Beyond the Repository

Quick start
Difference between domestic and overseas versions
FCM push
Local npm package
Patch npm package

FAQ

See FAQ.

Reference

See Reference.