https://github.com/G1Joshi/Booking-App
Full-Stack Dart Application using Flutter and Dart-Frog
https://github.com/G1Joshi/Booking-App
backend dart dart-frog flutter frontend full-stack postgres
Last synced: 4 months ago
JSON representation
Full-Stack Dart Application using Flutter and Dart-Frog
- Host: GitHub
- URL: https://github.com/G1Joshi/Booking-App
- Owner: G1Joshi
- Created: 2022-11-28T05:16:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-07T16:30:15.000Z (4 months ago)
- Last Synced: 2026-02-08T00:54:18.661Z (4 months ago)
- Topics: backend, dart, dart-frog, flutter, frontend, full-stack, postgres
- Language: Dart
- Homepage: http://g1joshi.dev/Booking-App/
- Size: 1.78 MB
- Stars: 29
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
- awesome_dart_frog - G1Joshi/Booking-App - stack booking application built with Flutter (Frontend) and Dart Frog (Backend). (Projects / Open source repos)
README
# 🏨 Booking App
[](https://github.com/G1Joshi/Booking-App/actions/workflows/main.yml)
[](https://melos.invertase.dev/)
A full-stack hotel booking application built with **Flutter** (Frontend) and **Dart Frog** (Backend) with **PostgreSQL** database. This application allows users to search for hotels, view details, make bookings, and leave reviews.
[](https://flutter.dev)
[](https://dart.dev)
[](https://docs.docker.com/)
[](https://www.postgresql.org)
---
## 📑 Table of Contents
- [Features](#-features)
- [Architecture](#-architecture)
- [Database Schema](#-database-schema-er-diagram)
- [Prerequisites](#-prerequisites)
- [Installation & Setup](#-installation--setup)
- [Initialize Workspace](#1-initialize-workspace)
- [Backend Setup](#2-backend-setup)
- [Running the Application](#-running-the-application)
- [Technologies Used](#-technologies-used)
- [Troubleshooting](#-troubleshooting)
---
## ✨ Features
### User Features
- 🔍 **Hotel Search** - Search hotels by location with radius-based filtering
- 🏨 **Hotel Listings** - Browse hotels with detailed information
- 🛏️ **Room Categories** - View different room types and availability
- 📅 **Booking System** - Book rooms with check-in/check-out dates
- ⭐ **Reviews & Ratings** - Read and write hotel reviews
- 🎯 **Advanced Filters** - Filter by star rating, property type, price, and more
- 📱 **Multi-Platform** - Runs on iOS, Android, Web, and Windows
### Admin Features
- 🏗️ **Hotel Management** - Add, update, and delete hotels
- 📊 **Data Seeding** - Generate fake data for testing (1000+ hotels)
- 🔑 **API Secret Key** - Admin operations protected by secret key
---
## 🏗️ Architecture
This application follows a **3-tier architecture**:
```
┌───────────────────────────────────────────────────────────────┐
│ PRESENTATION LAYER │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ Flutter Frontend (BLoC Pattern) │ │
│ │ ┌────────────┐ ┌────────────┐ ┌──────────────────┐ │ │
│ │ │ Auth Page │ │ Hotel List │ │ Hotel Details │ │ │
│ │ └────────────┘ └────────────┘ └──────────────────┘ │ │
│ │ ┌────────────┐ ┌────────────┐ ┌──────────────────┐ │ │
│ │ │ Auth Bloc │ │ Hotel Bloc │ │ Repositories │ │ │
│ │ └────────────┘ └────────────┘ └──────────────────┘ │ │
│ └─────────────────────────────────────────────────────────┘ │
└───────────────────────────────────────────────────────────────┘
▼ HTTP/REST API
┌────────────────────────────────────────────────────────────────┐
│ APPLICATION LAYER │
│ ┌──────────────────────────────────────────────────────────┐ │
│ │ Dart Frog Backend (RESTful API) │ │
│ │ ┌────────────────────────────────────────────────────┐ │ │
│ │ │ API Routes (v1) │ │ │
│ │ │ /auth/signup /auth/signin /hotels /search │ │ │
│ │ │ /hotels/:id/room /hotels/:id/review │ │ │
│ │ │ /hotels/:id/room/:id/booking │ │ │
│ │ └────────────────────────────────────────────────────┘ │ │
│ │ ┌────────────────────────────────────────────────────┐ │ │
│ │ │ Middleware Layer │ │ │
│ │ │ Auth │ DB Connection │ Services │ Logging │ │ │
│ │ └────────────────────────────────────────────────────┘ │ │
│ │ ┌────────────────────────────────────────────────────┐ │ │
│ │ │ Controllers & Services │ │ │
│ │ │ AuthController HotelController BookingService │ │ │
│ │ └────────────────────────────────────────────────────┘ │ │
│ └──────────────────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────────────────┘
▼ SQL Queries
┌────────────────────────────────────────────────────────────────┐
│ DATA LAYER │
│ ┌──────────────────────────────────────────────────────────┐ │
│ │ PostgreSQL Database │ │
│ │ ┌──────┐ ┌───────┐ ┌──────┐ ┌─────────┐ ┌───────┐ │ │
│ │ │Users │ │Hotels │ │Rooms │ │Bookings │ │Reviews│ │ │
│ │ └──────┘ └───────┘ └──────┘ └─────────┘ └───────┘ │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────────┐ │ │
│ │ │Address │ │Contact │ │Details │ │Localities │ │ │
│ │ └────────┘ └────────┘ └────────┘ └────────────┘ │ │
│ │ │ │
│ │ Triggers: Auto-update hotel ratings │ │
│ │ Functions: Distance calculation (geolocation) │ │
│ └──────────────────────────────────────────────────────────┘ │
└────────────────────────────────────────────────────────────────┘
```
### Frontend Architecture (Flutter BLoC)
```
apps/frontend/
├── lib/
│ ├── app/
│ │ ├── / # Feature-based organization
│ │ │ ├── bloc/ # State management (BLoC)
│ │ │ └── view/ # UI components & pages
│ ├── data/
│ │ ├── client/ # HTTP clients (e.g., Dio)
│ │ ├── model/ # Data models
│ │ └── repository/ # Data repositories
│ ├── config/ # App configuration (routes, theme)
│ └── l10n/ # Internationalization
```
### Backend Architecture (Dart Frog)
```
apps/backend/
├── routes/
│ ├── api/v1/
│ │ ├── / # Resource endpoints
│ │ │ ├── index.dart # GET / POST
│ │ │ └── [id].dart # Dynamic routes
│ └── index.dart # Root endpoint
├── lib/
│ ├── controller/ # Request handlers & validation
│ ├── service/ # Business logic
│ ├── middleware/ # Auth, logging, injection
│ ├── models/ # Re-exports from shared packages
│ └── database/
│ ├── extensions/ # *Db classes (HotelDb, UserDb, etc.)
│ └── tables.dart # Table name constants
```
### Shared Packages
```
packages/
├── models/ # booking_models: Shared DTOs (Hotel, User, Booking, etc.)
│ └── lib/src/ # common model files
└── utils/ # booking_utils: Shared utilities & API constants
└── lib/src/
├── endpoints.dart # API endpoint constants
└── rating_utils.dart
```
---
## 🗄️ Database Schema (ER Diagram)
```mermaid
erDiagram
users ||--o{ bookings : makes
users ||--o{ reviews : writes
hotels ||--o{ rooms : contains
hotels ||--o{ reviews : receives
hotels ||--|| address : has
hotels ||--|| contact : has
hotels ||--|| details : has
rooms ||--o{ bookings : has
users {
varchar id PK
varchar name
varchar email
varchar password
varchar access_token
varchar profile_image
bigint phone
date date_of_birth
varchar city
varchar state
varchar country
bigint pincode
}
hotels {
integer id PK
varchar name
text description
varchar property_type
varchar chain
integer star
real rating
integer rooms_starting_price
varchar cover_image
}
address {
serial id PK
varchar street
varchar city
varchar state
varchar country
bigint pincode
real latitude
real longitude
integer hotel_id FK
}
contact {
serial id PK
bigint phone
varchar email
varchar website
integer hotel_id FK
}
details {
serial id PK
text[] amenities
text[] rules
text[] preferences
text[] hotel_images
integer hotel_id FK
}
rooms {
serial id PK
varchar category
text description
integer price
integer count
integer capacity
text[] amenities
text[] room_images
integer hotel_id FK
}
bookings {
serial id PK
varchar status
date booking_date
date checkin
date checkout
integer rooms
integer guests
integer room_id FK
varchar user_id FK
}
reviews {
serial id PK
real rating
text review
text[] guest_images
integer hotel_id FK
varchar user_id FK
}
localities {
serial id PK
text name
real latitude
real longitude
}
```
### Key Relationships
- **Users** can make multiple **Bookings** and write multiple **Reviews**
- **Hotels** have one **Address**, one **Contact**, and one **Details** record
- **Hotels** contain multiple **Rooms** and receive multiple **Reviews**
- **Rooms** can have multiple **Bookings**
- **Localities** are used for geolocation-based search
### Database Functions & Triggers
- **`distance()`** - Calculates distance between two coordinates (geolocation search)
- **`update_hotel_rating()`** - Automatically updates hotel rating when a review is added
---
## 📋 Prerequisites
Before you begin, ensure you have the following installed:
- **Flutter SDK**: >= 3.35.0
- **Dart SDK**: >= 3.9.0 (comes with Flutter)
- **PostgreSQL**: >= 15.x
- **Docker & Docker Compose**: (Optional, for containerized setup)
- **Melos**: Install with `dart pub global activate melos`
- **Dart Frog CLI**: Install with `dart pub global activate dart_frog_cli`
- **Very Good CLI**: Install with `dart pub global activate very_good_cli`
### System Requirements
- **OS**: macOS, Linux, or Windows
- **RAM**: Minimum 8GB recommended
- **Storage**: 5GB free space
---
## 🚀 Installation & Setup
### 1. Initialize Workspace
#### Step 1.1: Clone the Repository
```bash
git clone https://github.com/G1Joshi/Booking-App.git
cd Booking-App
```
#### Step 1.2: Bootstrap Workspace
This command installs dependencies for all packages and links them.
```bash
melos run install
```
### 2. Backend Setup
#### Step 2.1: Initialize Database Schema
To initialize the database, you first need to start the backend services (which includes the database container).
1. **Start Backend**: Follow the instructions in [Running the Application](#-running-the-application) to start the backend.
2. **Initialize Schema**: Once the backend is running, run the following SQL scripts in order:
```
apps/backend/queries/
├── drop/
├── tables/
├── functions/
├── triggers/
└── seed/
```
---
## 🎮 Running the Application
This project uses **Melos** to manage scripts. You can run the backend and frontend using the following commands from the root of the project.
### Start Backend Server
```bash
melos run run:backend
```
This command will:
1. Start the Docker containers (PostgreSQL).
2. Start the Dart Frog development server on port `8090`.
Server will start at: `http://localhost:8090`
### Start Frontend Application
```bash
melos run run:frontend
```
This command will run the frontend in Chrome (Web) with the development flavor.
---
## 🛠️ Technologies Used
### Frontend
| Technology | Purpose |
| ----------------------------------------------------------------- | ------------------------------ |
| [Flutter](https://flutter.dev) | Cross-platform UI framework |
| [Dart](https://dart.dev) | Programming language |
| [flutter_bloc](https://pub.dev/packages/flutter_bloc) | State management (BLoC) |
| [Dio](https://pub.dev/packages/dio) | HTTP client for API calls |
| [shared_preferences](https://pub.dev/packages/shared_preferences) | Local storage for tokens |
| [flutter_rating_bar](https://pub.dev/packages/flutter_rating_bar) | Rating UI component |
| [shimmer](https://pub.dev/packages/shimmer) | Loading shimmer animations |
| [equatable](https://pub.dev/packages/equatable) | Value equality for BLoC |
| [intl](https://pub.dev/packages/intl) | Internationalization & formats |
### Backend
| Technology | Purpose |
| --------------------------------------------- | ----------------------------------- |
| [Dart Frog](https://dart-frog.dev) | Backend REST API framework |
| [Dart](https://dart.dev) | Programming language |
| [PostgreSQL](https://www.postgresql.org) | Relational database |
| [postgres](https://pub.dev/packages/postgres) | PostgreSQL driver for Dart |
| [uuid](https://pub.dev/packages/uuid) | UUID v4 for access token generation |
### DevOps
| Technology | Purpose |
| -------------------------------------------------- | ----------------------------- |
| [Docker](https://www.docker.com) | Containerization |
| [Docker Compose](https://docs.docker.com/compose/) | Multi-container orchestration |
| [Adminer](https://www.adminer.org) | Database management tool |
| [Melos](https://melos.invertase.dev) | Monorepo management |
---
## 🧪 Testing
### Backend Tests
```bash
melos run test:backend
```
### Frontend Tests
```bash
melos run test:frontend
```
### Shared Models Tests
```bash
melos run test:models
```
### Shared Utils Tests
```bash
melos run test:utils
```
---
## 🐛 Troubleshooting
### Backend Issues
**Issue: Database connection failed**
```
Solution:
1. Check if PostgreSQL is running: pg_isready
3. Ensure database exists: psql -l
```
### Frontend Issues
**Issue: Cannot connect to backend**
```
Solution:
1. Verify backend is running on localhost:8080
2. Check API_URL in lib/config/apis.dart
3. For physical devices, use network IP instead of localhost
```
---
## 👨💻 Author
**Jeevan Joshi** ([@G1Joshi](https://github.com/G1Joshi))
---
## 🙏 Acknowledgments
- [Very Good Ventures](https://verygood.ventures) for Flutter best practices
- [Dart Frog Team](https://dart-frog.dev) for the amazing backend framework
- [Invertase](https://invertase.io) for `Melos` to manage monorepo
- [Flutter Community](https://flutter.dev/community) for continuous support
---
**Happy Coding! 🚀**