This repository has been archived by the owner on Feb 22, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
106 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,107 +1,4 @@ | ||
| # Stream Chat Dart | ||
| [](https://pub.dartlang.org/packages/stream_chat) | ||
|  | ||
|  | ||
| [](https://codecov.io/gh/GetStream/stream-chat-dart) | ||
| # 🛑 Deprecated | ||
|
|
||
| stream-chat-dart is the official Dart client for Stream Chat, a service for building chat applications. This library can be used on any Dart project and on both mobile and web apps with Flutter. | ||
|
|
||
| You can sign up for a Stream account at https://getstream.io/chat/ | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Add dependency | ||
|
|
||
| ```yaml | ||
| dependencies: | ||
| stream_chat: ^0.2.0 | ||
| ``` | ||
|
|
||
| You should then run `flutter packages get` | ||
|
|
||
| ## Example Project | ||
|
|
||
| There is a detailed Flutter example project in the `example` folder. You can directly run and play on it. | ||
|
|
||
| ## Setup API Client | ||
|
|
||
| First you need to instantiate a chat client. The Chat client will manage API call, event handling and manage the websocket connection to Stream Chat servers. You should only create the client once and re-use it across your application. | ||
|
|
||
| ```dart | ||
| final client = Client("stream-chat-api-key"); | ||
| ``` | ||
|
|
||
| ### Logging | ||
|
|
||
| By default the Chat Client will write all messages with level Warn or Error to stdout. | ||
|
|
||
| #### Change Logging Level | ||
|
|
||
| During development you might want to enable more logging information, you can change the default log level when constructing the client. | ||
|
|
||
| ```dart | ||
| final client = Client("stream-chat-api-key", logLevel: Level.INFO); | ||
| ``` | ||
|
|
||
| #### Custom Logger | ||
|
|
||
| You can handle the log messages directly instead of have them written to stdout, this is very convenient if you use an error tracking tool or if you want to centralize your logs into one facility. | ||
|
|
||
| ```dart | ||
| myLogHandlerFunction = (LogRecord record) { | ||
| // do something with the record (ie. send it to Sentry or Fabric) | ||
| } | ||
| final client = Client("stream-chat-api-key", logHandlerFunction: myLogHandlerFunction); | ||
| ``` | ||
|
|
||
| ### Offline storage | ||
|
|
||
| By default the library saves information about channels and messages in a SQLite DB. | ||
|
|
||
| Set the property `persistenceEnabled` to false if you don't want to use the offline storage. | ||
|
|
||
| ## Flutter Web | ||
|
|
||
| Due to Moor web (for offline storage) you need to include the sql.js library: | ||
|
|
||
| ```html | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <script defer src="sql-wasm.js"></script> | ||
| <script defer src="main.dart.js" type="application/javascript"></script> | ||
| </head> | ||
| <body></body> | ||
| </html> | ||
| ``` | ||
|
|
||
| You can grab the latest version of sql-wasm.js and sql-wasm.wasm [here](https://github.com/sql-js/sql.js/releases) and copy them into your `/web` folder. | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Code conventions | ||
|
|
||
| - Make sure that you run `dartfmt` before commiting your code | ||
| - Make sure all public methods and functions are well documented | ||
|
|
||
| ### Running tests | ||
|
|
||
| - run `flutter test` | ||
|
|
||
| ### Releasing a new version | ||
|
|
||
| - update the package version on `pubspec.yaml` and `version.dart` | ||
|
|
||
| - add a changelog entry on `CHANGELOG.md` | ||
|
|
||
| - run `flutter pub publish` to publish the package | ||
|
|
||
| ### Watch models and generate JSON code | ||
|
|
||
| JSON serialization relies on code generation; make sure to keep that running while you make changes to the library | ||
|
|
||
| ```bash | ||
| flutter pub run build_runner watch | ||
| ``` | ||
| The package stream_chat has been moved to a [new monorepo](https://github.com/GetStream/stream-chat-flutter) that contains all the packages related to the Flutter SDK for Stream. | ||
| Check out [this announcement](https://getstream.io/blog/announcing-flutter-sdk-1-0-0-beta/) to know more about how we're making a step forward to help developers build great apps in as little time as possible. |