Skip to content

Commit a93f0dd

Browse files
Merge pull request #780 from GetStream/develop
Readme update
2 parents 2c33eac + fec3e62 commit a93f0dd

File tree

1 file changed

+6
-94
lines changed

1 file changed

+6
-94
lines changed

README.md

Lines changed: 6 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,25 @@
1010

1111
[![NPM](https://img.shields.io/npm/v/stream-chat-react-native.svg)](https://www.npmjs.com/package/stream-chat-react-native)
1212
[![Build Status](https://github.com/GetStream/stream-chat-react-native/workflows/test/badge.svg?branch=master)](https://github.com/GetStream/stream-chat-react-native/actions)
13-
[![Component Reference](https://img.shields.io/badge/docs-component%20reference-blue.svg)](https://getstream.github.io/stream-chat-react-native/v3/)
13+
[![Component Reference](https://img.shields.io/badge/docs-component%20reference-blue.svg)](https://getstream.io/chat/docs/sdk/reactnative)
1414

1515
<img align="right" src="https://getstream.imgix.net/images/ios-chat-tutorial/[email protected]?auto=format,enhance" width="50%" />
1616

1717
**Quick Links**
1818

1919
- [Stream Chat API](https://getstream.io/chat/) product overview
2020
- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Chat
21-
- [React Native Chat Tutorial](https://github.com/GetStream/stream-chat-react-native/wiki/Tutorial-v3.0)
21+
- [React Native Chat Tutorial](https://getstream.io/chat/react-native-chat/tutorial/)
2222
- [Chat UI Kit](https://getstream.io/chat/ui-kit/)
23+
- [Documentation](https://getstream.io/chat/docs/sdk/reactnative)
2324
- [Release Notes](https://github.com/GetStream/stream-chat-react-native/releases)
24-
- [Internationalization (i18n)](https://github.com/GetStream/stream-chat-react-native/wiki/Internationalization-(i18n))
25-
- [Cookbook](https://github.com/GetStream/stream-chat-react-native/wiki#v300) 🚀
2625

2726
## Contents
2827

2928
- [React Native Compatibility](#-react-native-compatibility)
3029
- [React Native Chat Tutorial](#-react-native-chat-tutorial)
3130
- [Example Apps](#-example-apps)
32-
- [Docs](#-docs)
3331
- [Keep in mind](#-keep-in-mind)
34-
- [Setup](#-Setup-(Setting-up-a-chat-app))
35-
- [TypeScript Support](#-TypeScript-Support)
36-
- [Internationalization](#-Internationalization)
37-
- [Upgrade](#-Upgrading)
38-
- [Common issues](#-common-issues)
3932
- [Contributing](#-contributing)
4033

4134
## 🔐 React Native Compatibility
@@ -63,36 +56,15 @@ For complete pricing details visit our [Chat Pricing Page](https://getstream.io/
6356

6457
This repo includes 4 example apps. One made with Expo, one Native JavaScript code, and two in TypeScript. One TypeScript app is a simple implementation for reference, the other is a more full featured app example.
6558

66-
6759
- [Expo example](./examples/ExpoMessaging)
6860
- [Native example](./examples/NativeMessaging)
6961
- [Typescript example](./examples/TypescriptMessaging)
7062
- [Fully featured messaging application](./examples/SampleApp)
7163

72-
<div style="display: inline">
73-
<img src="https://github.com/GetStream/stream-chat-react-native/blob/master/screenshots/readme/readmeChannel.png" alt="Channels" width="250" border="1" style="margin-right: 30px" />
74-
<img src="https://github.com/GetStream/stream-chat-react-native/blob/master/screenshots/readme/readmeMessages.png" alt="Messages" width="250" border="1" style="margin-right: 30px" />
75-
<img src="https://github.com/GetStream/stream-chat-react-native/blob/master/screenshots/readme/readmeOverlay.png" alt="Overlay" width="250" border="1" />
76-
</div>
77-
78-
### Slack clone
79-
80-
Check out our tutorial on how to build a slack clone using react-native and stream-chat-react-native
81-
82-
<div style="display: inline">
83-
<img src="https://camo.githubusercontent.com/386a2991e444ecff465372637699f1dba6913de1224effbb4b2520ae3a9d7593/68747470733a2f2f73747265616d2d626c6f672d76322e696d6769782e6e65742f626c6f672f77702d636f6e74656e742f75706c6f6164732f38306166346662623734613737613434363536373966363131386166373432372f696d6167652e706e67" alt="IMAGE ALT TEXT HERE"/>
84-
</div>
85-
86-
- **Tutorial** [https://dev.to/vishalnarkhede/how-to-build-slack-clone-with-react-native-part-2-g5](https://dev.to/vishalnarkhede/how-to-build-slack-clone-with-react-native-part-2-g5)
87-
88-
- **Source code for app**
89-
90-
- **react native** <https://github.com/GetStream/slack-clone-react-native/>
91-
- **expo** <https://github.com/GetStream/slack-clone-expo/>
64+
Besides, our team maintains a dedicated repository for fully-fledged sample applications and demos at [GetStream/react-native-samples](https://github.com/GetStream/react-native-samples). Please consider checking following sample applications:
9265

93-
## 📋 Docs
94-
95-
Please check following url for all the detailed documentation - https://github.com/GetStream/stream-chat-react-native/wiki#v300
66+
- [Slack Clone](https://github.com/GetStream/react-native-samples/tree/main/projects/SlackClone#slack-clone-using-react-native-and-stream-chat)
67+
- [iMessage Clone](https://github.com/GetStream/react-native-samples/tree/main/projects/iMessageClone#imessage-clone)
9668

9769
## 💬 Keep in mind
9870

@@ -102,66 +74,6 @@ Please check following url for all the detailed documentation - https://github.c
10274

10375
You can see detailed documentation about the components at <https://getstream.github.io/stream-chat-react-native>
10476

105-
## 🛠 Setup (Setting up a chat app)
106-
107-
Please follow this doc for setup - [Setup Docs](https://github.com/GetStream/stream-chat-react-native/wiki/Cookbook-v3.0#installation)
108-
## 💪 TypeScript Support
109-
110-
As of version `2.0.0` `stream-chat-react-native` has been converted to TypeScript. Please read [Typescript guide](https://github.com/GetStream/stream-chat-react-native/wiki/Typescript-support) for details.
111-
112-
## ✈️ Internationalization
113-
114-
Please read [Internationalization doc](https://github.com/GetStream/stream-chat-react-native/wiki/Internationalization-(i18n)) for details.
115-
116-
## 🚀 Upgrading
117-
118-
Please refer to [Upgrade Helper](https://github.com/GetStream/stream-chat-react-native/wiki/Upgrade-helper)
119-
120-
## ⚠️ Common issues
121-
122-
#### While running native example, you may (not necessarily) run into the following issues
123-
124-
1. When you execute `yarn ios` for the first time, it starts a metro bundler in parallel. It can result in some errors since the build process isn't complete yet. Try the following to fix this:
125-
1. Close/stop the metro bundler process.
126-
2. Let the build process finish. It can usually take around 2-3 minutes for the first time.
127-
3. Start the metro bundler manually by executing `yarn start` inside `stream-chat-react-native/examples/NativeMessaging` directory.
128-
2. When you execute `yarn android`, you may (not necessarily) run into following error:
129-
130-
```ERROR
131-
info Starting JS server...
132-
info Building and installing the app on the device (cd android && ./gradlew app:installDebug)...
133-
Starting a Gradle Daemon, 1 incompatible Daemon could not be reused, use --status for details
134-
135-
FAILURE: Build failed with an exception.
136-
137-
* What went wrong:
138-
A problem occurred configuring project ':@react-native-community_netinfo'.
139-
> SDK location not found. Define location with sdk.dir in the local.properties file or with an ANDROID_HOME environment variable.
140-
141-
* Try:
142-
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.
143-
144-
* Get more help at https://help.gradle.org
145-
146-
BUILD FAILED in 13s
147-
error Could not install the app on the device, read the error above for details.
148-
Make sure you have an Android emulator running or a device connected and have
149-
set up your Android development environment:
150-
https://facebook.github.io/react-native/docs/getting-started.html
151-
error Command failed: ./gradlew app:installDebug. Run CLI with --verbose flag for more details.
152-
```
153-
154-
To resolve this, do the following.
155-
156-
1. Create a file named `local.properties` inside `stream-chat-react-native/examples/NativeMessaging/android` directory
157-
2. Put the this line in that file. Make sure sdk path is correctly mentioned as per your system:
158-
159-
```
160-
sdk.dir=/Users/{user_name}/Library/Android/sdk/
161-
```
162-
163-
3. Rerun `yarn android` in `stream-chat-react-native/examples/NativeMessaging` directory
164-
16577
## 👏 Contributing
16678

16779
We welcome code changes that improve this library or fix a problem, and please make sure to follow all best practices and test all the changes. Please check our [dev setup docs](https://github.com/GetStream/stream-chat-react-native/wiki/Dev-setup-for-contributing-to-the-library) to get you started. We are pleased to merge your code into the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.

0 commit comments

Comments
 (0)