maszkimum-alert (Android-only)

Coming soon on iOS, and on the web.

Alerting mobile app based on the Maszkimum web API

When did the project start?

A few weeks ago I noticed a 15 year old, Hungarian, non-skid programmer called Dávid Fegyver. I was browsing his projects, when I noticed an AI-based mask detecting system made for a competition. He made a feature request called Alerting system to an operator. I contacted him, and started making an alerting mobile app.

How to use it

1. Run the app: there's a bunch of methods for doing that

• You can download the .apk file directly from GitHub releases (easiest method)
  • On your phone, go to GitHub releases
  • Download the latest release
  • Open your phone's file manager
  • Click on the downloaded app
  • Install it
  • Start it
• You can compile the app for yourself (if you don't trust GitHub releases 😆)
  • Open up a terminal
  • Install git for your system (only, if you haven't did it already)
  • Clone this GitHub repository

  git clone https://github.com/piciakk/maszkimum-alert

  • Navigate to the cloned GitHub repo:

  cd maszkimum-alert

  • Install Node & NPM (only, if you haven't did it already)
  • Install Expo using NPM (only, if you haven't did it already)

  npm install -g expo-cli

  • Compile the application

  expo build:android

  • One liner for the above steps (NPM & Node & git & expo required)

  git clone https://github.com/piciakk/maszkimum-alert && cd maszkimum-alert && expo build:android

  • Install the app on your phone
    • Go to expo.dev
    • Click on Builds
    • Select maszkimum-alert from the list
    • Click on the Download button
    • Find the downloaded .apk file, and install it
    • Start it
• You can launch the app in development mode using expo (not recommended for everyday use)
  • Clone this repo (git required)

  git clone https://github.com/maszkimum-alert

  • Navigate to the cloned repository

  cd maszkimum-alert

  • Start the app (Expo, Node, and NPM required)

  expo start

2. Start the Maszkimum web API

• Install Python3 if you haven't did it already
• Install, and start Maszkimum using the installation instructions on the official repository
  • Clone the Maszkimum repository

  git clone https://github.com/davidfegyver/szabadfogasu-maszk

  • Open up the newly cloned repository

  cd szabadfogasu-maszk

  • Install the dependencies

  pip3 install -r requirements.txt

  • Start the app

  python3 maskdetector.py

3. Find out the IP address of the server computer

• GNU/Linux
  • Open up a terminal
  • Type the following:

  hostname -I | awk '{print $1}'

• MacOS
  • Open up a terminal
  • Type the following:

  ipconfig getifaddr en0

• Windows
  • Open up a terminal
  • Type the following

  ipconfig /all

  • Check your IPv4 address
• Cross-platform
  • When you start the Maszkimum Web API, it should log the IP address of the server

4. Enter the IP address, and port

• If you're in the app, open the text field, and type the IP Address you just found out
• At the end of the IP Address add: :5000 (if you specified the port of the webserver with command-line arguments, then replace 5000 with the port of the webserver)

5. Wait for the notification

• If somebody isn't wearing a mask, you should get a notification from the maszkimum-alert application.

Contribution

If you have a question about this app: you can contact me on Discord; if you have an issue with this app: you can start a GitHub issue; if you have a feature request, or an idea: you can start an issue, or make the feature, and start a Pull Request.