Skip to content

Commit

Permalink
Merge pull request #563 from talkjs/chore/add-version-numbers
Browse files Browse the repository at this point in the history
Add version info to React and RN projects
  • Loading branch information
keerlu authored Dec 4, 2024
2 parents b54d869 + 2d0336c commit ef2ea27
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 13 deletions.
5 changes: 3 additions & 2 deletions react-native/basic-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ The examples in this directory demonstrate how to use TalkJS with React Native t
- [ReactNavigationExample](./ReactNavigationExample/) uses the [React Navigation](https://reactnavigation.org/docs/getting-started/) library to navigate between screens
- [ReactNativeNavigationExample](./ReactNativeNavigationExample/) uses the [React Native Navigation](https://wix.github.io/react-native-navigation/docs/before-you-start/) library

> [!TIP]
> [Download these example projects as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react-native.basic-example.zip)
The examples use React Native version 0.73. You can use the React Native SDK with versions 0.64 and up.

> [!TIP] > [Download these example projects as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react-native.basic-example.zip)
5 changes: 3 additions & 2 deletions react/basic-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

This is a basic example that demonstrates how to integrate TalkJS into a React app with our [React SDK](https://talkjs.com/docs/Reference/React_SDK/Installation/), bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

> [!TIP]
> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.basic-example.zip)
This example uses React version 18. You can use the React SDK with versions 17 and up.

> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.basic-example.zip)
## Prerequisites

Expand Down
5 changes: 3 additions & 2 deletions react/next.js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ This example accompanies our [Add chat to a Next.js app with TalkJS](https://tal

The React SDK is not able to render components on the server, so we use Next.js's [Client Components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) to render them on the client.

> [!TIP]
> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.next.js.zip)
This example uses React version 18.

> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.next.js.zip)
## Prerequisites

Expand Down
10 changes: 5 additions & 5 deletions react/remote-work-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

This example shows you how to use React and TalkJS to create a team chat with channels (like Slack or Teams). It's similar to the [remote work demo](https://talkjs.com/demo/team-chat/) that you can try on our website. See our [How to use TalkJS to create a team chat with channels](https://talkjs.com/resources/how-to-use-talkjs-to-create-a-team-chat-with-channels/) tutorial for more details.

> [!TIP]
> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip)
The example uses React version 18. You can use the React SDK with versions 17 and up.

> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip)
## Instructions

1. Clone or [download this project](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.remote-work-demo.zip).
2. Install dependencies by either running `npm install` or `yarn`.
3. Create a [TalkJS account](https://talkjs.com/dashboard/signup/).
4. In `talkjsConfig.js`, replace `appId` with your own app ID. You can find your app ID on the **Settings** page of your [TalkJS dashboard](https://talkjs.com/dashboard/).
4. In `talkjsConfig.js`, replace `appId` with your own app ID. You can find your app ID on the **Settings** page of your [TalkJS dashboard](https://talkjs.com/dashboard/).
5. From this point on, you're ready to start up the app using using either `npm run` or `yarn start`. The app will be up and running at localhost:3000.

The app is prepopulated with a default user and a couple of hardcoded conversations, which easily can be replaced with your own users and conversations. You can find these conversations and the default `userId` in `src/talkJsConfig.js` as well.

The app is prepopulated with a default user and a couple of hardcoded conversations, which easily can be replaced with your own users and conversations. You can find these conversations and the default `userId` in `src/talkJsConfig.js` as well.
5 changes: 3 additions & 2 deletions react/team-chat-with-threads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ This example extends our [team chat with channels example](https://github.com/ta

See our [How to add reply threads to your TalkJS team chat](https://talkjs.com/resources/how-to-add-threads-to-your-team-chat-with-talkjs/) tutorial for more details.

> [!TIP]
> [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.team-chat-with-threads.zip)
The example uses React version 18. You can use the React SDK with versions 17 and up.

> [!TIP] > [Download this example project as a zip file](https://github.com/talkjs/talkjs-examples/releases/latest/download/react.team-chat-with-threads.zip)
## Prerequisites

Expand Down

0 comments on commit ef2ea27

Please sign in to comment.