Getting Started
Project Structure
What is in the BookMyStay package, which folder builds which app, and the few configuration files you will edit yourself.
Folder Tour Codebase Layout
BookMyStay is cleanly organized into modular projects for the Admin Panel, Customer application, Cloud Functions, and Firebase setup automation. All parts connect to a single Firebase backend.
The download at a glance#
BookMyStay/
├── admin_panel/ Admin Panel (Flutter Web) — dashboard, bookings, branches, rooms, inventory
├── customer/ Customer App (Flutter) — one project builds Website, Android and iOS
├── functions/ Cloud Functions (Node.js 22 LTS) — pricing, booking holds, payments, emails
├── firebase_setup/ Automated Setup Tool — web server, starter database.json, rules
└── documentation/ HTML Documentation — open index.html in any browser
| Folder | What it is | Runs on | Tech stack |
|---|---|---|---|
admin_panel/ |
Admin Panel for Super Admin, branch managers, and front desk staff. | Web (Chrome, Safari, Firefox, Edge) | Flutter 3.47+ Web · GetX · Responsive UI |
customer/ |
Customer application: stay search, live availability, room booking, wallet, reviews. | Android, iOS, and Web (Customer Website) | Flutter 3.47+ · Android 16 (API 36) · iOS 14+ |
functions/ |
Backend logic: 30-min room holds, server-side payment verification, automated wallet refunds, check-in reminders. | Firebase Cloud Functions | Node.js 22 LTS · Firebase Admin SDK |
firebase_setup/ |
Web-based setup wizard with start.sh & start.bat to deploy Firestore rules, Storage rules, and demo data. |
Local computer | Node.js · Express · Starter JSON |
Inside admin_panel/#
admin_panel/
├── lib/
│ ├── app/
│ │ ├── modules/ Each screen has its own folder (dashboard, bookings, branches, rooms, staff, settings...)
│ │ ├── components/ Reusable UI components (buttons, text fields, dialogs, image pickers)
│ │ ├── data/ Models and repositories for Firestore data
│ │ └── routes/ App routing and navigation guards
│ ├── firebase_options.dart Firebase web keys (written by FlutterFire)
│ └── main.dart Application entry point
└── web/
├── firebase-messaging-sw.js Web push background worker
├── index.html HTML entry with favicon and title
└── .htaccess Apache rewrite rules for clean URLs
Inside customer/#
customer/
├── lib/
│ ├── app/
│ │ ├── modules/ Home, explore, stay detail, booking, checkout, wallet, reviews, profile
│ │ ├── components/ Shared widgets and responsive layouts
│ │ ├── services/ Auth, payment gateways, push notifications, storage services
│ │ └── theme/ Brand colors, typography, dark mode
│ ├── firebase_options.dart Cross-platform Firebase configuration
│ └── main.dart Entry point
├── android/ Android native project (package name, permissions, build.gradle.kts)
├── ios/ iOS Xcode project (Runner.xcworkspace, Info.plist, Podfile)
└── web/ Web assets (firebase-messaging-sw.js, manifest.json, index.html)
Files you edit by hand#
Most branding and business rules are set in the Admin Panel. Only a few build configuration files need manual editing during setup:
| File | What you change | Covered in |
|---|---|---|
admin_panel/lib/firebase_options.dart |
Written automatically by flutterfire configure --platforms=web |
Connect the Apps |
customer/lib/firebase_options.dart |
Written automatically by flutterfire configure --platforms=web,android,ios |
Connect the Apps |
admin_panel/web/firebase-messaging-sw.js |
Paste your Firebase web config values into firebase.initializeApp({...}) |
Connect the Apps |
customer/web/firebase-messaging-sw.js |
Paste the same Firebase web config values for customer web push | Connect the Apps |
customer/ios/Runner/Info.plist |
Replace two placeholder URL schemes with your iOS Client ID and App ID | Connect the Apps |