Certainly! Here's the updated markdown file with the information about using Elastic Search for searching contacts:
ChatBox is a real-time chat application built using Flutter and Firebase that allows users to communicate with each other in a seamless and interactive manner. This app provides a user-friendly interface and supports instant messaging between multiple users.
- User authentication: Users can sign up and log in securely to access the chat functionalities.
- Real-time messaging: Users can send and receive messages in real-time, creating a smooth chat experience.
- Group chat: ChatBox supports group chat functionality, allowing users to create and join chat rooms.
- Image sharing: Users can share images within the chat rooms, making conversations more engaging.
- Push notifications: Users receive push notifications for new messages even when the app is in the background.
- Contact search: Utilizes Elastic Search for efficient searching and retrieval of contacts.
- Clone the repository to your local machine using the following command:
git clone https://github.com/RamyBouchareb25/chat-box
-
Make sure you have Flutter and Dart installed on your development environment.
-
Install the required packages by running:
flutter pub get
-
Set up Firebase for the project and add your
google-services.json
file in theandroid/app
directory for Android andGoogleService-Info.plist
file in theios
directory for iOS. -
Run the app on an emulator or physical device using the following command:
flutter run
To configure the app and Firebase services, you need to update the following files:
android/app/google-services.json
(for Android)ios/Runner/GoogleService-Info.plist
(for iOS)
Enable the necessary authentication methods (e.g., Email/Password, Google Sign-In) in the Firebase console.
Set up Firestore and create the required collections and documents for storing chat messages and user information.
We welcome contributions to improve ChatBox. To contribute, follow these steps:
- Fork the repository.
- Create a new branch.
- Make your changes and commit them.
- Push the changes to your forked repository.
- Submit a pull request, describing the changes you made.
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub.
Thank you for checking out ChatBox! We hope this app provides you with an excellent platform for seamless communication and collaboration. If you have any questions or need assistance, feel free to reach out to us.
Happy chatting! 😄📱