|
|
@@ -1,2 +1,29 @@
|
|
|
# flutter_chat_ui
|
|
|
|
|
|
+
|
|
|
+<p align="center">
|
|
|
+ <a href="https://flyer.chat">
|
|
|
+ <img alt="Chat Image" src="https://user-images.githubusercontent.com/14123304/193468140-91942302-2332-4cb1-8504-61b8892d828b.jpg" />
|
|
|
+ </a>
|
|
|
+</p>
|
|
|
+
|
|
|
+<br>
|
|
|
+
|
|
|
+Flyer Chat is a platform for creating in-app chat experiences using Flutter or [React Native](https://github.com/flyerhq/react-native-chat-ui). This repository contains chat UI implementation for Flutter.
|
|
|
+
|
|
|
+* **Free, open-source and community-driven**. We offer no paid plugins and strive to create an easy-to-use, almost drop-in chat experience for any application. Contributions are more than welcome! Please read our [Contributing Guide](CONTRIBUTING.md).
|
|
|
+
|
|
|
+* **Backend agnostic**. You can choose the backend you prefer. But if you don't have one, we provide our own free and open-source [Firebase implementation](https://pub.dev/packages/flutter_firebase_chat_core), which can be used to create a working chat in minutes. We are also working on our more advanced SaaS and self-hosted solutions.
|
|
|
+
|
|
|
+* **Customizable**. Supports custom themes, locales and more. Check our [documentation](https://docs.flyer.chat/flutter/chat-ui/) for the info. More options are on the way, let us know if something is missing.
|
|
|
+
|
|
|
+* **Minimum dependencies**. Our packages are lightweight. Use your favourite packages for selecting images, opening files etc. See the [example](https://github.com/flyerhq/flutter_chat_ui/blob/main/example/lib/main.dart) for possible implementation.
|
|
|
+
|
|
|
+## Getting Started
|
|
|
+
|
|
|
+### Requirements
|
|
|
+
|
|
|
+`Dart >=2.18.0` and `Flutter >=2.0.0`
|
|
|
+
|
|
|
+Read our [documentation](https://docs.flyer.chat/flutter/chat-ui/) or see the [example](https://github.com/flyerhq/flutter_chat_ui/tree/main/example) project.
|
|
|
+
|
