Skip to content

Commit 79a2f05

Browse files
Add READMEs to tutorials repo.
1 parent 8aaff2c commit 79a2f05

File tree

12 files changed

+626
-12
lines changed

12 files changed

+626
-12
lines changed

AI/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Stream AI Tutorial Projects
2+
3+
This directory contains tutorial projects that demonstrate how to integrate AI capabilities with Stream's Chat and Video SDKs. Each subdirectory corresponds to a specific AI implementation or tutorial from getstream.io.
4+
5+
## Included Projects
6+
7+
### iOS_AI_Assistant
8+
A Swift/SwiftUI implementation of an AI assistant integrated with Stream Chat, demonstrating:
9+
- Natural language processing
10+
- Context-aware AI responses
11+
- Real-time chat with AI assistance
12+
- RAG (Retrieval Augmented Generation) implementation
13+
14+
### Multi-Agent-AI
15+
A project showcasing multi-agent AI systems with Stream, featuring:
16+
- Multiple AI agents working together
17+
- Agent-to-agent communication
18+
- Human-in-the-loop workflows
19+
- Specialized AI agents for different tasks
20+
21+
## Tutorial Links
22+
23+
- [AI Chat Documentation](https://getstream.io/chat/docs/ai-chat/)
24+
- [Building AI Assistants with Stream](https://getstream.io/blog/)
25+
- [AI Moderation with Stream](https://getstream.io/chat/ai-moderation/)
26+
27+
## Getting Started
28+
29+
Each project has specific setup instructions, but generally require:
30+
31+
1. A Stream account with API credentials
32+
2. Access to an AI provider (OpenAI, Anthropic, etc.)
33+
3. Programming language-specific dependencies
34+
4. Configuration of environment variables for API keys
35+
36+
To run a specific project:
37+
1. Navigate to the project directory
38+
2. Install the required dependencies
39+
3. Set up your API credentials
40+
4. Follow the project-specific instructions
41+
42+
## Try Stream for Free
43+
44+
Ready to add AI capabilities to your chat or video application?
45+
46+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
47+
2. **[Check out our AI documentation](https://getstream.io/chat/docs/ai-chat/)** - Comprehensive guides
48+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
49+
50+
## Additional Resources
51+
52+
- [Stream Chat GitHub Repositories](https://github.com/GetStream)
53+
- [AI Integration Tutorials](https://getstream.io/blog/topic/tutorials/ai/)
54+
- [Stream Blog](https://getstream.io/blog/)
55+
- [AI Moderation Documentation](https://getstream.io/chat/ai-moderation/)

AndroidCompose/README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Stream Android Jetpack Compose Tutorial Projects
2+
3+
This directory contains Android tutorial projects built with Jetpack Compose that implement Stream's Chat and Video SDKs. Each project corresponds to a specific tutorial or implementation example from getstream.io.
4+
5+
## Overview
6+
7+
These projects demonstrate how to integrate Stream's powerful real-time communication capabilities into Android applications using the modern Jetpack Compose UI toolkit. The examples cover:
8+
9+
- Building chat interfaces with Compose
10+
- Creating video calling functionality
11+
- Implementing custom UI components
12+
- Creating real-time messaging experiences
13+
- Building meeting and livestreaming applications
14+
15+
## Tutorial Links
16+
17+
- [Android Compose Chat SDK Documentation](https://getstream.io/chat/docs/sdk/android/)
18+
- [Android Video SDK Documentation](https://getstream.io/video/docs/android/)
19+
- [Build a Real-Time Meeting App for Android with Jetpack Compose](https://getstream.io/blog/topic/tutorials/2/)
20+
- [Building an Uber Clone in Jetpack Compose](https://getstream.io/blog/topic/tutorials/2/)
21+
22+
## Getting Started
23+
24+
Each project typically requires:
25+
26+
1. Android Studio Arctic Fox (2020.3.1) or newer
27+
2. Kotlin 1.5.0 or higher
28+
3. A Stream account with API credentials
29+
4. Gradle for dependency management
30+
31+
To run a specific project:
32+
1. Navigate to the project directory
33+
2. Open the project in Android Studio
34+
3. Update the Stream API credentials in the project
35+
4. Build and run on an emulator or physical device
36+
37+
## Try Stream for Free
38+
39+
Ready to add powerful chat, video, and audio features to your Android app?
40+
41+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
42+
2. **[Check out our Android SDK documentation](https://getstream.io/chat/docs/sdk/android/)** - Comprehensive guides
43+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
44+
45+
## Additional Resources
46+
47+
- [Stream Android Chat GitHub Repository](https://github.com/GetStream/stream-chat-android)
48+
- [Stream Android Video SDK GitHub Repository](https://github.com/GetStream/stream-video-android)
49+
- [Android Tutorials](https://getstream.io/blog/topic/tutorials/compose/)
50+
- [Stream Blog](https://getstream.io/blog/)

JavaScript/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Stream JavaScript SDK Examples
2+
3+
This directory contains implementations and examples using Stream's JavaScript SDK for chat messaging and activity feeds.
4+
5+
## Overview
6+
7+
These examples demonstrate how to implement Stream's features using JavaScript without additional frameworks. The examples show:
8+
9+
- Setting up the Stream JavaScript client
10+
- Connecting to channels
11+
- Authenticating users
12+
- Sending and receiving messages
13+
- Implementing activity feeds
14+
- Working with custom events
15+
16+
## Getting Started
17+
18+
Each example typically requires:
19+
20+
1. Navigating to the specific example directory
21+
2. Opening the HTML file or installing dependencies if needed
22+
3. Updating the example with your Stream API credentials
23+
4. Running the example either by opening the HTML file or starting a development server
24+
25+
## Tutorial Links
26+
27+
Check out Stream's JavaScript SDK tutorials and guides:
28+
29+
- [JavaScript Chat SDK Documentation](https://getstream.io/chat/docs/javascript/)
30+
- [Chat Messaging Tutorial](https://getstream.io/chat/docs/javascript/tutorial/)
31+
- [Activity Feeds Documentation](https://getstream.io/activity-feeds/docs/javascript/)
32+
33+
## Try Stream for Free
34+
35+
Ready to implement Stream in your JavaScript application?
36+
37+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
38+
2. **[Check out our JavaScript SDK documentation](https://getstream.io/chat/docs/javascript/)** - Comprehensive guides
39+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
40+
41+
## Additional Resources
42+
43+
- [Stream Chat JavaScript GitHub Repository](https://github.com/GetStream/stream-chat-js)
44+
- [Stream Feed JavaScript GitHub Repository](https://github.com/GetStream/stream-js)
45+
- [Stream Blog](https://getstream.io/blog/)
46+
- [JavaScript Tutorials](https://getstream.io/blog/topic/tutorials/javascript/)

PHP-Chat/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Stream PHP Chat Tutorial
2+
3+
This directory contains the implementation for the [How To Build a Real-Time PHP Chat App](https://getstream.io/blog/build-a-chat-messaging-platform-in-php/) tutorial on getstream.io.
4+
5+
## Overview
6+
7+
This sample project demonstrates how to build a real-time chat application using PHP as the backend and JavaScript for the frontend. The tutorial covers:
8+
9+
- Setting up Stream's PHP SDK
10+
- Generating authentication tokens
11+
- Creating a chat interface
12+
- Sending and receiving messages in real-time
13+
- Implementing typing indicators and user presence
14+
15+
## Getting Started
16+
17+
To run this project:
18+
19+
1. Clone this repository
20+
2. Navigate to this directory
21+
3. Install dependencies:
22+
```
23+
composer install
24+
```
25+
4. Update the project with your Stream API credentials
26+
5. Start a PHP server:
27+
```
28+
php -S localhost:9090
29+
```
30+
6. Open your browser to `http://localhost:9090/page.php`
31+
32+
## Tutorial Link
33+
34+
For the complete step-by-step tutorial, visit:
35+
[How To Build a Real-Time PHP Chat App](https://getstream.io/blog/build-a-chat-messaging-platform-in-php/)
36+
37+
## Try Stream for Free
38+
39+
Want to build powerful chat functionality into your own PHP application?
40+
41+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
42+
2. **[Check out our PHP SDK documentation](https://getstream.io/chat/docs/php/?language=php)** - Comprehensive guides
43+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
44+
45+
## Additional Resources
46+
47+
- [Stream Chat PHP GitHub Repository](https://github.com/GetStream/stream-chat-php)
48+
- [Laravel Chat Tutorial](https://getstream.io/blog/chat-messaging-with-laravel/)
49+
- [Stream Blog](https://getstream.io/blog/)

README.md

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,67 @@
1-
## Stream Developers [iOS/SwiftUI](https://youtube.com/playlist?list=PLNBhvhkAJG6tJYnY-5oZ1JCp2fBNbVL_6), [Android/Compose](https://youtube.com/playlist?list=PLNBhvhkAJG6tbp6aGqQ81gU4VdARMWsin&si=7RKmg4em4HSBY-I8), and [React Native](https://youtube.com/playlist?list=PLNBhvhkAJG6u7ewQJPQMuIZBAfIAsA5RY&si=hSoX1fdBsBLG3vp6) Tutorial Projects.
1+
# Stream Tutorial Projects
22

3-
- [iOS Swift SDK for chat messaging](https://getstream.io/chat/sdk/ios/)
4-
- [React Native Chat SDK](https://getstream.io/chat/sdk/react-native/)
5-
- [Android Chat SDK](https://getstream.io/chat/sdk/android/)
3+
This repository contains sample projects and implementations that accompany tutorials, blog posts, and documentation on [getstream.io](https://getstream.io).
64

7-
You can find the projects in their respective folders.
5+
Stream provides APIs and SDKs for:
6+
- [Chat Messaging](https://getstream.io/chat/)
7+
- [Activity Feeds](https://getstream.io/activity-feeds/)
8+
- [Video & Audio](https://getstream.io/video/)
9+
- [AI Moderation](https://getstream.io/chat/ai-moderation/)
810

9-
## [SwiftUI Telegram Clone](TelegramClone): Text/voice messaging, audio/video calling, and animations
11+
Each directory in this repository corresponds to a specific tutorial or set of tutorials on the Stream website.
12+
13+
## Project Directories
14+
15+
### React & JavaScript
16+
- **[React-Chat-App/](React-Chat-App/)**: Implementation of the [React Chat Tutorial](https://getstream.io/chat/react-chat/tutorial/)
17+
- **[React_E2EE_Chat/](React_E2EE_Chat/)**: End-to-End encrypted chat implementation for React
18+
- **[ReactNative/](ReactNative/)**: Sample projects for [React Native Chat SDK tutorials](https://getstream.io/chat/react-native-chat/tutorial/)
19+
- **[JavaScript/](JavaScript/)**: JavaScript-specific implementations of Stream features
20+
21+
### iOS & SwiftUI
22+
- **[iOS-SwiftUI/](iOS-SwiftUI/)**: Collection of SwiftUI tutorial projects including:
23+
- [TelegramClone](iOS-SwiftUI/TelegramClone/): From the [How To Build a Telegram Clone with SwiftUI](https://getstream.io/blog/threads-clone-swiftui/) tutorial
24+
- [SwiftUILiveStreaming](iOS-SwiftUI/SwiftUILiveStreaming/): Livestreaming implementation for iOS
25+
- [FaceTimeClone](iOS-SwiftUI/FaceTimeClone/): From the [Building a Full-Stack FaceTime Clone with SwiftUI](https://getstream.io/blog/topic/tutorials/2/) tutorial
26+
- **[iOS-Swift/](iOS-Swift/)**: Swift (UIKit) tutorial implementations
27+
- **[visionOS/](visionOS/)**: visionOS Drawing App tutorial implementation
28+
29+
### Android
30+
- **[AndroidCompose/](AndroidCompose/)**: Jetpack Compose implementations for Android
31+
32+
### Other Platforms
33+
- **[PHP-Chat/](PHP-Chat/)**: Implementation from the [How To Build a Real-Time PHP Chat App](https://getstream.io/blog/build-a-chat-messaging-platform-in-php/) tutorial
34+
35+
### AI & Advanced Use Cases
36+
- **[AI/](AI/)**: AI-related implementations including:
37+
- [iOS_AI_Assistant](AI/iOS_AI_Assistant/): AI assistant implementation for iOS
38+
- [Multi-Agent-AI](AI/Multi-Agent-AI/): Multi-agent AI systems with Stream
39+
- **[ReasoningLLMs/](ReasoningLLMs/)**: Implementations related to reasoning with large language models
40+
41+
## Featured Tutorials
42+
43+
### SwiftUI Telegram Clone
1044
![SwiftUI Telegram Clone](Misc/mainPresentation.gif)
11-
---
1245

13-
## visionOS Drawing App
14-
![SwiftUI Telegram Clone](Misc/visionDrawFinal.gif)
15-
---
46+
### visionOS Drawing App
47+
![visionOS Drawing App](Misc/visionDrawFinal.gif)
1648

17-
## PencilKit SwiftUI Drawing App
49+
### PencilKit SwiftUI Drawing App
1850
![PencilKit SwiftUI Drawing App](Misc/faceboard.gif)
19-
---
51+
52+
## Get Started with Stream
53+
54+
Want to build powerful chat, activity feeds, or video/audio calling into your applications? Stream makes it easy to get started:
55+
56+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
57+
2. **[Check out our documentation](https://getstream.io/chat/docs/)** - Comprehensive guides for all platforms
58+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
59+
60+
## Resources
61+
62+
- [Stream Blog](https://getstream.io/blog/)
63+
- [YouTube Tutorials](https://youtube.com/playlist?list=PLNBhvhkAJG6tJYnY-5oZ1JCp2fBNbVL_6)
64+
- [GitHub Repositories](https://github.com/GetStream)
2065

2166
## Building Fun SwiftUI Animations
2267
Watch the tutorial on [YouTube](https://www.youtube.com/playlist?list=PLNBhvhkAJG6tJYnY-5oZ1JCp2fBNbVL_6)

React-Chat-App/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# React Chat App
2+
3+
This project contains the implementation for the [React Chat Tutorial](https://getstream.io/chat/react-chat/tutorial/) on getstream.io.
4+
5+
## Overview
6+
7+
This sample application demonstrates how to build a real-time chat app using Stream's Chat API and React SDK. The tutorial covers:
8+
9+
- Setting up a Stream Chat client
10+
- Creating and connecting to channels
11+
- Sending and receiving messages in real-time
12+
- Using Stream's UI components
13+
- Customizing the chat experience
14+
- Working with reactions, threads, and more
15+
16+
## Getting Started
17+
18+
1. Clone this repository
19+
2. Navigate to this directory
20+
3. Install dependencies:
21+
```
22+
npm install
23+
```
24+
or
25+
```
26+
yarn
27+
```
28+
4. Update the project with your Stream API credentials
29+
5. Start the development server:
30+
```
31+
npm start
32+
```
33+
or
34+
```
35+
yarn start
36+
```
37+
38+
## Tutorial Link
39+
40+
For the complete step-by-step tutorial, visit:
41+
[React Chat Tutorial: How to build a chat app](https://getstream.io/chat/react-chat/tutorial/)
42+
43+
## Try Stream for Free
44+
45+
Want to build powerful chat functionality into your own React application?
46+
47+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
48+
2. **[Check out our React Chat SDK documentation](https://getstream.io/chat/docs/react/)** - Comprehensive guides
49+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
50+
51+
## Additional Resources
52+
53+
- [Stream Chat React GitHub Repository](https://github.com/GetStream/stream-chat-react)
54+
- [Stream Chat React Component Docs](https://getstream.io/chat/docs/sdk/react/)
55+
- [Stream Blog](https://getstream.io/blog/)

ReactNative/Readme.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1+
# React Native Chat & Video Tutorials
12

3+
This directory contains various sample projects that implement Stream's React Native SDKs for chat messaging, video calling, and audio rooms. Each subdirectory corresponds to specific tutorials and implementation examples from getstream.io.
4+
5+
## Included Projects
6+
7+
- **Livestreaming/**: Implementation of livestreaming features with React Native
8+
- **NativeCall/**: Sample project demonstrating video and audio calling capabilities
9+
- **NativeExpoChat/**: Chat implementation for React Native using Expo
10+
- **AudioRoom/**: Implementation of audio room functionality similar to Clubhouse or Twitter Spaces
11+
12+
## Tutorial Links
13+
14+
- [React Native Chat App Tutorial](https://getstream.io/chat/react-native-chat/tutorial/) - Learn how to build a mobile chat application similar to Facebook Messenger or Telegram
15+
- [React Native Video Tutorial](https://getstream.io/video/docs/react-native/) - Add video calling capabilities to your React Native app
16+
17+
## Getting Started with Individual Projects
18+
19+
Each subdirectory contains its own project with specific setup instructions. In general, you'll need to:
20+
21+
1. Navigate to the specific project directory
22+
2. Install dependencies (usually `npm install` or `yarn`)
23+
3. Set up your Stream API credentials
24+
4. Run the project with the appropriate command for your platform:
25+
```
26+
npm run android
27+
npm run ios
28+
```
29+
or
30+
```
31+
yarn android
32+
yarn ios
33+
```
34+
35+
## Try Stream for Free
36+
37+
Ready to add powerful chat and video capabilities to your React Native application?
38+
39+
1. **[Sign up for a free Stream account](https://getstream.io/try-for-free/)** - No credit card required
40+
2. **[Check out our React Native SDK documentation](https://getstream.io/chat/docs/sdk/react-native/)** - Comprehensive guides
41+
3. **[Join our Discord community](https://discord.gg/stream)** - Connect with other developers and the Stream team
42+
43+
## Additional Resources
44+
45+
- [Stream Chat React Native GitHub Repository](https://github.com/GetStream/stream-chat-react-native)
46+
- [Stream Blog](https://getstream.io/blog/)
47+
- [React Native Tutorials](https://getstream.io/blog/topic/tutorials/react-native/)

0 commit comments

Comments
 (0)