README.md

June 21, 2025 ยท View on GitHub

Health Screening App Logo

๐Ÿฉบ Health Screening App ๐Ÿฉบ

QR-based health screening for safe public entry

Build Status License Angular pnpm


โœจ 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

Scan QR Code Example Health Quiz Example

๐Ÿ“ฆ Prerequisites

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

  1. At the entry point, users scan the provided QR code using the application.
  2. The app presents a short health quiz.
  3. Users answer the quiz questions.
  4. 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.