From bbebd4c8f39fb97ab1498de7a5c2d5136d9c2bd4 Mon Sep 17 00:00:00 2001 From: Rajit Deb Date: Sun, 12 May 2024 15:35:55 +0530 Subject: [PATCH] Updated README.md with detailed project information --- README.md | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5985261..4adc9f9 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,34 @@ -# flash_chat_flutter +# About - Flash Chat Flutter 🌟 +A multi-user chat app built using Firebase and Flutter. -A new Flutter project. +## Objective 🎯 +The objective of this project is to learn how to incorporate Firebase into Flutter apps. We'll be using Firebase Cloud Firestore as well as the Firebase authentication package to equip our app with a cloud-based NoSQL database and secure authentication methods. And also understand the nity-gritty of firebase firestore and authentication. -## Getting Started +## Project Demo 📽 +You can find the project demo [here](https://drive.google.com/file/d/1lsphS3iy2dwVSjtoq9y0fVOBt0c5BWKx/view?usp=sharing). -This project is a starting point for a Flutter application. +## Screenshots 📷 +| Screenshot 1 | Screenshot 2 | Screenshot 3 | +| :------------: | :------------: | :------------: | +| [![1.jpg](https://i.postimg.cc/vmLZkTcc/1.jpg)](https://postimg.cc/DW0hb2QT) | [![2.jpg](https://i.postimg.cc/zvfw349F/2.jpg)](https://postimg.cc/LYrgbQ4J) | [![3.jpg](https://i.postimg.cc/FRbm1Bjz/3.jpg)](https://postimg.cc/MMGgFt3J) | +| **Screenshot 4** | +| [![4.jpg](https://i.postimg.cc/nhtLVq83/4.jpg)](https://postimg.cc/svwzwQgW) | -A few resources to get you started if this is your first Flutter project: +## Important Announcement +>[!IMPORTANT] +>This project is missing important Firebase files (for security purposes) but all other dependencies are in place. So if anyone wants to clone the project and see the actual working then they need to follow some additional steps to get it working. -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +## Steps to get started 👩‍💻 +1. Clone the project +2. Go to your Firebase console +3. Login, if not yet logged in and then create a Firebase Project +4. Follow the steps mentioned in the console regarding FlutterFire CLI and project setup +5. When the firebase project is completely setup, tap on Get dependencies +6. Run the project +7. Voila! Its running -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +## Author 🧑 +Rajit Deb + +## Find me on 🔍 +[![LinkedIn Profile](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/imrajit/)