Skip to content

JunichiGetCode/HaramainQU

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ•‹ HaramainQu

Umrah & Hajj Companion App β€” Built with Flutter

Flutter Dart Riverpod REST API Status License

🚧 This project is currently under active development. Features and UI are subject to change.

A comprehensive mobile companion app for Umrah & Hajj pilgrims, powered by the Haramain Tour backend.


πŸ“Œ About

HaramainQu is a mobile application designed to accompany pilgrims throughout their Umrah and Hajj journey in the Holy Land. It provides step-by-step ibadah guidance, progress tracking, doa collections, and practical tools β€” all in one app.

HaramainQu connects to the Haramain Tour Laravel backend via REST API, authenticated using token-based auth with Laravel Sanctum.


✨ Features

Module Description
πŸ” Auth Login, logout, and splash screen session management
🏠 Home Main dashboard with pilgrimage summary and info
πŸ“– Panduan Ibadah Step-by-step Umrah & Hajj ritual instructions
βœ… Progress Ibadah Checklist to track completed rukun of Umrah/Hajj
πŸ”’ Tracking Ibadah Counter to track Thawaf, Sa'i rounds, and other rituals
🀲 Doa & Dzikir Collection of essential prayers and daily dhikr
πŸ“– Kamus Arab Mini Arabic dictionary for practical pilgrim communication
⏰ Reminder Notifications for ibadah schedules and trip agenda
πŸ‘€ Profile Pilgrim profile management and account settings
πŸ“° Berita Latest news and updates from Haramain Tour

πŸ› οΈ Tech Stack

Category Technology
Framework Flutter
State Management flutter_riverpod
Navigation go_router (with deep linking support)
HTTP Client dio (with token interceptor)
Local Storage shared_preferences + Hive (NoSQL local DB)
Fonts google_fonts
Animations lottie, flutter_animate, shimmer
Backend Haramain Tour (Laravel 11 + REST API)

πŸ—οΈ Architecture

This project follows a Feature-First Clean Architecture approach, separating code by feature for scalability and maintainability.

lib/
β”œβ”€β”€ core/                   # Global utilities & services
β”‚   β”œβ”€β”€ api_service.dart    # Dio HTTP client with auth interceptor
β”‚   β”œβ”€β”€ theme/              # App theme & design tokens
β”‚   β”œβ”€β”€ constants/          # App-wide constants
β”‚   └── services/           # Notification & storage services
β”‚
β”œβ”€β”€ features/               # Feature modules (UI + Business Logic)
β”‚   β”œβ”€β”€ auth/               # Login, logout, splash screen
β”‚   β”œβ”€β”€ home/               # Main dashboard
β”‚   β”œβ”€β”€ panduan_ibadah/     # Ibadah step-by-step guide
β”‚   β”œβ”€β”€ progress_ibadah/    # Rukun checklist tracker
β”‚   β”œβ”€β”€ tracking_ibadah/    # Thawaf/Sa'i counter
β”‚   β”œβ”€β”€ doa_dzikir/         # Prayers & dhikr collection
β”‚   β”œβ”€β”€ kamus_arab/         # Arabic dictionary
β”‚   β”œβ”€β”€ reminder/           # Schedule reminders
β”‚   └── profile/            # User profile & settings
β”‚
└── data/                   # Data models & sources
    β”œβ”€β”€ models/             # Data models
    └── repositories/       # Local & remote data sources

πŸ”— System Architecture

HaramainQu (Flutter Mobile App)
          ↓  REST API (Dio + Token Interceptor)
 Haramain Tour (Laravel 11 Backend)
          ↓  Query
      MySQL Database

Authentication is handled via Laravel Sanctum token-based auth. The token is stored locally using shared_preferences and automatically attached to every API request via a Dio interceptor.


πŸš€ Getting Started

Prerequisites

  • Flutter SDK >= 3.x
  • Dart >= 3.x
  • Android Studio / VS Code
  • Android Emulator or physical device

Installation

# 1. Clone the repository
git clone https://github.com/JunichiGetCode/haramainqu.git
cd haramainqu

# 2. Install dependencies
flutter pub get

# 3. Configure API base URL
# Open lib/core/constants/ and set your Haramain Tour backend URL

# 4. Run the app
flutter run

πŸ“Έ Screenshots

🚧 This app is currently under active development. Screenshots will be added upon release.


πŸ”— Related Repository

This app is the mobile frontend for the Haramain Tour web platform.

πŸ‘‰ Haramain Tour β€” Laravel Backend


🀝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you'd like to change.


πŸ“„ License

This project is licensed under the MIT License.


Built with ❀️ using Flutter β€” Ω„ΩŽΨ¨ΩŽΩ‘ΩŠΩ’ΩƒΩŽ Ψ§Ω„Ω„ΩŽΩ‘Ω‡ΩΩ…ΩŽΩ‘ Ω„ΩŽΨ¨ΩŽΩ‘ΩŠΩ’ΩƒΩŽ

About

πŸ•‹ Mobile companion app for Umrah & Hajj pilgrims β€” built with Flutter, powered by Haramain Tour backend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors