README.md
June 21, 2025 ยท View on GitHub
๐ฉบ Health Screening App ๐ฉบ
QR-based health screening for safe public entry
โจ Overview
Health Screening App is a modern, QR-based health screening solution designed to check the health of users at the entry of any public place. Users simply scan a QR code and answer a quick quiz to determine their health status before entry. Perfect for offices, events, malls, and more!
๐ Quick Start
# 1. Clone the repository
$ git clone <repository-url>
$ cd health-screening-fe
# 2. Install dependencies (requires pnpm)
$ pnpm install
# 3. Start the development server
$ pnpm run start
# 4. Open your browser and visit
http://localhost:4200/
โก Tip: Make sure you have pnpm installed. If not, run
npm install -g pnpm.
๐ ๏ธ Features
- ๐ฑ QR code scanning for fast user identification
- ๐ Simple health quiz for screening
- โก Real-time health status evaluation
- ๐ฅ๏ธ User-friendly interface for public entry points
- ๐ Fast & responsive (built with Angular)
๐ธ Example Usage
๐ฆ Prerequisites
- Node.js (v16 or higher recommended)
- Angular CLI
- pnpm (used as the package manager for this project)
pnpm Installation
If you do not have pnpm installed, you can install it globally:
npm install -g pnpm
โน๏ธ Note: This project uses pnpm for faster, more efficient dependency management. All commands in this README assume pnpm is installed.
๐งโ๐ป Usage
- At the entry point, users scan the provided QR code using the application.
- The app presents a short health quiz.
- Users answer the quiz questions.
- Based on the answers, the app determines if the user is eligible to enter.
๐๏ธ Building for Production
To build the project for production:
pnpm run build
The build artifacts will be stored in the dist/ directory.
๐งช Running Tests
- Unit tests:
pnpm run test - End-to-end tests:
pnpm run e2e(requires additional setup)
๐ค Contributing
Contributions are welcome! Please fork the repository and submit a pull request.
๐ License
This project is licensed under the MIT License.