Updated README.md

master
Faiz Hashmi 3 weeks ago
parent 1247b70b04
commit d9f58bd09a

@ -1,8 +1,10 @@
# HMG_QLine # HMG_QLine
HMG_QLine is a Flutter-based application designed for efficient patient management and queue handling in healthcare environments. It features multiple screens for patient display, robust logging, and background service integration to ensure reliability and uptime. HMG_QLine is a Flutter-based application designed for efficient patient management and queue handling in healthcare environments. It features multiple screens for patient display, robust logging, and
background service integration to ensure reliability and uptime.
## Features ## Features
- Patient queue management across all screens - Patient queue management across all screens
- Foreground service to monitor app state and auto-reopen if terminated or backgrounded - Foreground service to monitor app state and auto-reopen if terminated or backgrounded
- SignalR integration for real-time updates - SignalR integration for real-time updates
@ -13,11 +15,13 @@ HMG_QLine is a Flutter-based application designed for efficient patient manageme
## Getting Started ## Getting Started
### Prerequisites ### Prerequisites
- Flutter SDK (>=3.0.0) - Flutter SDK (>=3.0.0)
- Dart (>=2.17.0) - Dart (>=2.17.0)
- Android Studio or Xcode for platform-specific builds - Android Studio or Xcode for platform-specific builds
### Installation ### Installation
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://github.com/your-org/HMG_QLine.git git clone https://github.com/your-org/HMG_QLine.git
@ -33,38 +37,45 @@ HMG_QLine is a Flutter-based application designed for efficient patient manageme
``` ```
## Project Structure ## Project Structure
- `lib/` - Main source code - `lib/` - Main source code
- `api/` - API integration - `api/` - API integration
- `config/` - Configuration files - `config/` - Configuration files
- `constants/` - App-wide constants - `constants/` - App-wide constants
- `models/` - Data models - `models/` - Data models
- `repositories/` - Data repositories - `repositories/` - Data repositories
- `services/` - Business logic and background services - `services/` - Business logic and background services
- `utilities/` - Utility functions - `utilities/` - Utility functions
- `view_models/` - State management - `view_models/` - State management
- `views/` - UI screens - `views/` - UI screens
- `assets/` - Fonts, images, icons, and tones - `assets/` - Fonts, images, icons, and tones
- `android/`, `ios/`, `macos/`, `linux/`, `windows/` - Platform-specific code - `android/`, `ios/`, `macos/`, `linux/`, `windows/` - Platform-specific code
## Logging ## Logging
- Logs are saved in the device's external storage under `/logs/` - Logs are saved in the device's external storage under `/logs/`
- Log files are rotated every 48 hours - Log files are rotated every 48 hours
- Each log entry includes a timestamp, source, and type - Each log entry includes a timestamp, source, and type
## Foreground Service ## Foreground Service
- Monitors app lifecycle - Monitors app lifecycle
- Automatically reopens or restarts the app if terminated or sent to background - Automatically reopens or restarts the app if terminated or sent to background
- Checks app status every minute - Checks app status every minute
## SignalR Integration ## SignalR Integration
- Reconnects automatically after disconnection - Reconnects automatically after disconnection
- Ensures real-time updates for patient queues - Ensures real-time updates for patient queues
## Debugging ## Debugging
- Debuggable builds can be enabled in `android/app/build.gradle` for troubleshooting - Debuggable builds can be enabled in `android/app/build.gradle` for troubleshooting
## Contributing ## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License ## License
This project is licensed under the MIT License. This project is licensed under the MIT License.
Loading…
Cancel
Save