talksik/stream-chat-flutter
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #608 from GetStream/docs/review

Browse Source 
docs(doc): intro and contribution files
This commit is contained in:
Salvatore Giordano
2021-08-16 16:21:16 +02:00
committed by GitHub
parent 923155cff6 3ef2c4027c
commit 92ec5e8d6a
2 changed files with 17 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+2
View File
@@ -52,6 +52,8 @@ Stream's Flutter code is kept in a single mono-repository consisting of multiple
`stream_chat_persistence` - This package provides a persistence client for fetching and saving chat data locally. Stream Chat Persistence uses Moor as a disk cache. `stream_chat_persistence` - This package provides a persistence client for fetching and saving chat data locally. Stream Chat Persistence uses Moor as a disk cache.
`stream_chat_localizations` - This package provides a set of localizations for the SDK.
### Local Setup ### Local Setup
Congratulations! 🎉. You've successfully cloned our repo, and you are ready to make your first contribution. Before you can start making code changes, there are a few things to configure. Congratulations! 🎉. You've successfully cloned our repo, and you are ready to make your first contribution. Before you can start making code changes, there are a few things to configure.
docusaurus/docs/Flutter/basics/introduction.mdx
+15 -14
View File
@@ -8,13 +8,14 @@ Exploring The Basics Of Stream Chat
![](../assets/sdk_title.png) ![](../assets/sdk_title.png)
Stream Chat is a service that helps you easily build a full chat experience in your Flutter (and more) apps. Stream Chat is a service that helps you easily build a full chat experience in your Flutter apps.
We also support a variety of other SDKs.
This section of the documentation focuses on our Flutter SDK which helps you easily This section of the documentation focuses on our Flutter SDK which helps you easily
ship high quality messaging experiences in apps and programs built with the [Flutter toolkit made ship high quality messaging experiences in apps and programs built with the [Flutter toolkit
by Google](https://flutter.dev). made by Google](https://flutter.dev).
The Stream Chat Flutter SDK comprises of four different packages to choose from ranging from ones The Stream Chat Flutter SDK comprises five different packages to choose from, ranging from ones
giving you complete control to ones that give you a rich out-of-the-box chat experience. giving you complete control to ones that give you a rich out-of-the-box chat experience.
The packages that make up the Stream Chat SDK are: The packages that make up the Stream Chat SDK are:
@@ -30,28 +31,28 @@ reusable and customisable UI components.
saving chat data locally. saving chat data locally.
5. <b>Localizations (stream_chat_localizations)</b>: provides a set of localizations for the SDK. 5. <b>Localizations (stream_chat_localizations)</b>: provides a set of localizations for the SDK.
We recommend building prototypes using the full UI package since it contains UI widgets already We recommend building prototypes using the full UI package, [stream_chat_flutter](https://pub.dev/packages/stream_chat_flutter),
integrated with Stream's API. [stream_chat_flutter](https://pub.dev/packages/stream_chat_flutter) since it contains UI widgets already integrated with Stream's API. It is the fastest way to get up
is the fastest way to get up and running using Stream chat in your app. and running using Stream chat in your app.
The Flutter SDK enables you to build any type of chat or messaging experience for Android, iOS, Web The Flutter SDK enables you to build any type of chat or messaging experience for Android, iOS, Web
and Desktop. and Desktop.
If you're building a very custom UI and would prefer a more lean package, If you're building a very custom UI and would prefer a more lean package,
our [core package](https://pub.dev/packages/stream_chat_flutter) will be suited to this use case. Core allows you to build custom, [stream_chat_flutter_core](https://pub.dev/packages/stream_chat_flutter_core) will be suited to this
expressive UIs while retaining the benefits of our full Flutter SDK. use case. Core allows you to build custom, expressive UIs while retaining the benefits of our full
APIs for accessing and controlling users, sending messages, etc are seamlessly integrated into Flutter SDK. APIs for accessing and controlling users, sending messages, and so forth are seamlessly integrated
this package and accessible via providers and builders. into this package and accessible via providers and builders.
Before going into the docs, let's take a small detour to look at how the elements of Stream Chat are structured. Before going into the docs, let's take a small detour to look at how the elements of Stream Chat are structured.
### Basic Structure ### Basic Structure
There are two core elements in chat, <b>Users and Channels.</b> There are two core elements in chat, <b>Users</b> and <b>Channels</b>.
Channels are groups of one or more users that can message each other. Channels are groups of one or more users that can message each other.
In an app, you need to have a user connected to query channels. In an app, you need to have a user connected to query channels.
There is no specific distinction between a chat between two people and a group chat, There is no specific distinction between a chat with only two people and a group chat,
but there is a way to create a unique chat between a certain number of people by creating a <b>distinct</b> channel. but there is a way to create a unique chat between a certain number of people by creating a <b>distinct</b> channel.
![](../assets/chat_basics.png) ![](../assets/chat_basics.png)
@@ -68,7 +69,7 @@ While this is a simplistic overview of the service, the Flutter SDK handles the
Before reading the docs, consider trying our [online API tour](https://getstream.io/chat/get_started/), Before reading the docs, consider trying our [online API tour](https://getstream.io/chat/get_started/),
it is a nice way to learn how the API works. it is a nice way to learn how the API works.
It's in-browser so Javascript-based but the ideas are pretty much the same as Dart. It's in-browser so you'll need to use Javascript but the core conceps are pretty much the same as Dart.
You may also like to look at the [Flutter tutorial](https://getstream.io/chat/flutter/tutorial/) You may also like to look at the [Flutter tutorial](https://getstream.io/chat/flutter/tutorial/)
which focuses on using the UI package to get Stream Chat integrated into a Flutter app. which focuses on using the UI package to get Stream Chat integrated into a Flutter app.