47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# Flutter Chat Components
|
|
|
|
<a href="https://getstream.io/chat/"><img src="https://i.imgur.com/L4Mj8S2.png" alt="Flutter Chat" /></a>
|
|
|
|
> The official Flutter components for Stream Chat, a service for
|
|
> building chat applications.
|
|
|
|
[](https://pub.dartlang.org/packages/stream_chat_flutter)
|
|
|
|
|
|
[](https://codecov.io/gh/GetStream/stream-chat-flutter)
|
|
|
|
**Quick Links**
|
|
|
|
- [Register](https://getstream.io/chat/trial/) to get an API key for Stream Chat
|
|
- [Flutter Chat Tutorial](https://getstream.io/chat/flutter/tutorial/) [WIP]
|
|
- [Chat UI Kit](https://getstream.io/chat/ui-kit/)
|
|
|
|
## Flutter Chat Tutorial
|
|
|
|
The best place to start is the [Flutter Chat Tutorial](https://getstream.io/chat/flutter/tutorial/). It teaches you how to use this SDK and also shows how to make common changes.
|
|
|
|
## Example App
|
|
|
|
TODO
|
|
|
|
### Add dependency
|
|
|
|
```yaml
|
|
dependencies:
|
|
stream_chat_flutter: ^0.0.1
|
|
```
|
|
|
|
You should then run `flutter packages get`
|
|
|
|
## Docs
|
|
|
|
TODO
|
|
|
|
### Customizing styles
|
|
|
|
TODO
|
|
|
|
## Contributing
|
|
|
|
We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in 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.
|