Skip to content

Commit 343b493

Browse files
committed
update README
1 parent cb388be commit 343b493

File tree

8 files changed

+46
-10
lines changed

8 files changed

+46
-10
lines changed

.env.example

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
API_KEY=,
2+
APP_ID=,
3+
messagingSenderId=,
4+
projectId=
5+
app_url=
6+
bucket=

README.md

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,46 @@
1-
# chat_app
1+
# 📝 Chat App
22

3-
A new Flutter project.
3+
A modern chat application built with **Flutter**, **GetX** for state management, and **Firebase** for real-time communication. The app features a sleek UI with a **multi-step signup process, profile management, and real-time chat** with support for images, audio, and text messages.
44

5-
## Getting Started
5+
---
66

7-
This project is a starting point for a Flutter application.
7+
## ✨ Features
88

9-
A few resources to get you started if this is your first Flutter project:
9+
- 🔹 **Multi-step signup** with a beautiful UI
10+
- 🔹 **Modern dark mode design** for forms, profile, and chat screens
11+
- 🔹 **Real-time messaging** with users and friends
12+
- 🔹 **Send & receive images, audio messages, and text**
13+
- 🔹 **Firebase integration** for seamless chat experience
1014

11-
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
15+
---
1316

14-
For help getting started with Flutter development, view the
15-
[online documentation](https://docs.flutter.dev/), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.
17+
## 🚀 Tech Stack
18+
19+
- **Flutter** (Cross-platform development)
20+
- **GetX** (State management)
21+
- **Firebase** (Real-time database & authentication)
22+
23+
---
24+
25+
## 📸 Screenshots
26+
<img src="assets/screenshots/login.jpg" width="150"/> <img src="assets/screenshots/signup.jpg" width="150"/> <img src="assets/screenshots/signup2.jpg" width="150"/>
27+
28+
<img src="assets/screenshots/profile.jpg" width="150"/> <img src="assets/screenshots/chat_screen.jpg" width="150"/> <img src="assets/screenshots/conversations.jpg" width="150"/>
29+
30+
---
31+
32+
## 📥 Installation
33+
34+
1. **Clone the repository**
35+
```sh
36+
git clone https://github.com/mazineab/flutter_chat_app.git
37+
### 2️⃣ **Set up Firebase**
38+
1. Go to the [Firebase Console](https://console.firebase.google.com/) and create a **new project**.
39+
2. Enable **Firebase services**:
40+
- **Firebase Authentication**
41+
- **Cloud Firestore**
42+
3. Download the `google-services.json` and place it in the `android/app` folder.
43+
44+
### 3️⃣ **Set up Environment Variables**
45+
1. Rename the `.env.example` file to `.env`
46+
2. Add your Firebase API keys, project ID, and other credentials.

assets/screenshots/chat_screen.jpg

118 KB
Loading

assets/screenshots/conversations.jpg

53.1 KB
Loading

assets/screenshots/login.jpg

92.9 KB
Loading

assets/screenshots/profile.jpg

125 KB
Loading

assets/screenshots/signup.jpg

115 KB
Loading

assets/screenshots/signup2.jpg

130 KB
Loading

0 commit comments

Comments
 (0)