English | Chinese

Update time: 2022-06-16

IM React-Native Description

This SDK is based on the native Android and iOS version of React Native implemented in the typescript language. Android is detailed here. Portal. iOS is detailed here. Portal.

directory description

├── CHANGELOG.md // Release notes document
├── CONTRIBUTING.md // Contributor documentation
├── LICENSE // License file
├── README.md // Project help documentation
├── README.zh.md // Project help documentation (Chinese version)
├── android // react native SDK android platform folder
├── docs // docs folder
├── example // project built-in demo
├── examples // Independent demo outside the project
├── ios // react native SDK ios platform folder
├── lib // react native SDK generates product folder
├── native_src // react native SDK native source code folder
├── node_modules // react native depends folder, generated by yarn or npm command
├── package.json // react native project management file
├── react-native-chat-sdk.podspec // react native ios cocoapods configuration file, used by ios platform.
├── scripts // react native script folder
├── src // react native source code folder
├── tsconfig.build.json // typescript language build configuration file
├── tsconfig.json // typescript language configuration file
└── yarn.lock // yarn project dependency version configuration file

project acquisition

Download using git command

1git clone --recurse-submodules git@github.com:easemob/react-native-chat-sdk.git

Project development environment requirements

For details, please refer to the Quick Start demo. Portal

project build and run

Open a terminal and run yarn or yarn install command

Build ios platform

• use xcode to open the file example/ios/ChatSdkExample.xcworkspace;
• Connect an ios device, or choose an emulator;
• set the signature (if it is a real machine);
• Execute build, install and run demo.
• Note The pod install command has been executed when running the yarn command, otherwise, it needs to be run manually.

Build the android platform

• use android studio to open the folder example/android;
• If it is the first time, please run the sync command first;
• Execute build, install and run demo;
• Before running the demo, start the service: cd example && yarn start.
• NOTE Make sure to execute the following command before building: cd native_src/cpp && sh generate.sh --type rn
• Note android5.0 or above, data forwarding is required: adb reverse tcp:8081 tcp:8081

quick start

See the Quick Start documentation for details. Portal

demo experience

For details, see the demo of running the experience api. portal. For details, see the demo of running experience login, logout, sending and receiving messages. portal.

Contributors

See Contributor Guide for details. Portal.

Release Notes

See the changelog for details. Portal.

Release type description

See version type description for details. Portal.

Developer Instructions

See developer instructions for details. Portal.

User Instructions

See the User Instructions Portal for details.

License

MIT

Q & A

If you encounter problems, please refer to here. Portal.