1
- # Flatify Frontend
1
+ # 🏠 Flatify Frontend
2
2
3
3
🌟 ** Flatify** is a modern web application for browsing, posting, and managing roommate or flat listings.
4
4
@@ -16,14 +16,14 @@ The live app is deployed at:
16
16
17
17
## ✨ Features
18
18
19
- ✅ User authentication (Firebase)
20
- ✅ Browse flat/roommate listings
21
- ✅ Post your own listings
22
- ✅ Like & review listings
23
- ✅ Swiper carousels for banners and featured
24
- ✅ Smooth animations (React Awesome Reveal)
25
- ✅ Toast notifications (React Hot Toast)
26
- ✅ Responsive & mobile-friendly (Tailwind + DaisyUI)
19
+ - ✅ User authentication (Firebase)
20
+ - ✅ Browse flat/roommate listings
21
+ - ✅ Post your own listings
22
+ - ✅ Like & review listings
23
+ - ✅ Swiper carousels for banners and featured content
24
+ - ✅ Smooth animations (React Awesome Reveal)
25
+ - ✅ Toast notifications (React Hot Toast)
26
+ - ✅ Fully responsive & mobile-friendly (Tailwind + DaisyUI)
27
27
28
28
---
29
29
@@ -38,3 +38,85 @@ The live app is deployed at:
38
38
| ** UX** | SweetAlert2, React Hot Toast, Swiper |
39
39
40
40
---
41
+
42
+ ## 🛠️ How to Run Locally
43
+
44
+ Follow these steps to run ** Flatify Frontend** on your local development environment:
45
+
46
+ ### Step 1: Clone the Repository
47
+
48
+ ``` bash
49
+ git clone https://github.com/your-username/flatify-frontend.git
50
+ cd flatify-frontend
51
+ ````
52
+
53
+ > Replace ` your-username` with your actual GitHub username.
54
+
55
+ ---
56
+
57
+ # ## Step 2: Install Dependencies
58
+
59
+ ` ` ` bash
60
+ npm install
61
+ ` ` `
62
+
63
+ ---
64
+
65
+ # ## Step 3: Create a Firebase Project
66
+
67
+ 1. Go to [https://console.firebase.google.com/](https://console.firebase.google.com/)
68
+ 2. Create a new project
69
+ 3. Go to ** Project Settings > General > Your Apps**
70
+ 4. Register a new Web App
71
+ 5. Copy the Firebase config, which looks like this:
72
+
73
+ ` ` ` js
74
+ const firebaseConfig = {
75
+ apiKey: " your_api_key" ,
76
+ authDomain: " your_auth_domain" ,
77
+ projectId: " your_project_id" ,
78
+ storageBucket: " your_storage_bucket" ,
79
+ messagingSenderId: " your_sender_id" ,
80
+ appId: " your_app_id"
81
+ };
82
+ ` ` `
83
+
84
+ ---
85
+
86
+ # ## Step 4: Create a `.env` File
87
+
88
+ 1. In the ** root directory** of your project, create a file named ` .env`
89
+ 2. Add your Firebase config like this:
90
+
91
+ ` ` ` env
92
+ VITE_API_KEY=your_api_key
93
+ VITE_AUTH_DOMAIN=your_auth_domain
94
+ VITE_PROJECT_ID=your_project_id
95
+ VITE_STORAGE_BUCKET=your_storage_bucket
96
+ VITE_MESSAGING_SENDER_ID=your_sender_id
97
+ VITE_APP_ID=your_app_id
98
+ ` ` `
99
+
100
+ > ⚠️ Do not commit this ` .env` file to your repo. Keep it private.
101
+
102
+ ---
103
+
104
+ # ## Step 5: Start the Development Server
105
+
106
+ ` ` ` bash
107
+ npm run dev
108
+ ` ` `
109
+
110
+ ---
111
+
112
+ # ## Step 6: Open the App
113
+
114
+ Visit the following URL in your browser:
115
+
116
+ ```
117
+ http://localhost:5173
118
+ ```
119
+
120
+ You should now see the **Flatify** app running locally! 🎉
121
+
122
+
0 commit comments