Introduction

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, 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
├── example
├── examples
│   ├── callkit-example
│   └── uikit-example
├── node_modules
├── package.json
├── packages
│   ├── 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:
- 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-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-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.