https://github.com/cpendery/vtcheck

A Covid-19 Contract Tracing Application made for Virginia Tech as part of the VT Tech Together Challenge
https://github.com/cpendery/vtcheck

Last synced: about 2 months ago
JSON representation

A Covid-19 Contract Tracing Application made for Virginia Tech as part of the VT Tech Together Challenge

• Host: GitHub
• URL: https://github.com/cpendery/vtcheck
• Owner: cpendery
• Created: 2021-08-12T00:15:35.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-12T00:15:45.000Z (over 3 years ago)
• Last Synced: 2024-10-26T00:27:59.768Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 225 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  


  



A Covid-19 Contact Tracing App created to compete in Virginia Tech's  Tech Together Challenge. Reached finalist standing


# VTCheck

## Project Information

VTCheck is a mobile and web application for Virginia Tech to view and manage occupancies around campus. Doors will be outfitted with minimalistic, non-intrusive tags, and using NFC technology and QR codes, students and faculty will check-in to classrooms, dining halls, and study spaces. Other forms of occupancy detection can be used as well. These groups will be able to view which rooms are open, restricted, or closed at any given time. This allows students and faculty to plan their days accordingly, save time, and avoid piling up in hallways.

With VT Check, administrators can create controls and adjust restrictions on occupancies in key facilities and rooms to better comply with CDC guidelines on social distancing. Furthermore, the data can also be used to facilitate contact tracing initiatives. If a student is reported to have tested positive for COVID-19, the app can be useful for identifying locations that may have been exposed to an infected individual.

This solution allows Virginia Tech as a student body, faculty body, and an administrative body to work as a cohesive unit to optimize our university’s facilities to deal with COVID-19. Administrators can more effectively regulate occupancy, which will help achieve a safe learning environment, while those checking-in and out of rooms will be contributing social awareness about what rooms and buildings are available. This behavior will provide peace of mind both in the context of the virus and outside of it as well.

## Setup

To check out a  copy of this repository:

    git clone https://github.com/cpendery/VTCheck.git

Once you have cloned this repository, you will need to install the VTCheck stack using Docker.

Once you have the environment set up, including making sure Docker is currently running on your machine, you can run the following command:

    make.sh

This command will first pull and build the VTCheck images before instantiating the VTCheck containers. It will also populate the mysql database with the proper tables and starting data.

 **The website should now be running** 


## Usage

To view a student profile, register a new account on the site.

To view an admin profile, use these credentials 
 

`Username: [email protected]` 


`Password: Password`

## Features

 - User Accounts

 - Admin Account Permission Management

 - Creating, Deleting, & Updating Rooms

 - Signing into & out of rooms

 - Viewing room status

 - Filtering room data

## Mobile App

A mobile iOS app compatable with the api can be found here.

## Demos

Linked below are the ending set of demos:

Stage 3 Demo

Final Stage Demo

## Known Bugs

 - Encryption: *The VTCheckSVC/creds.py file shouldn't be posted publiclly, but as this project isn't hosted its totally fine*

 - Refresh: *data doesn't refresh upon action unless manual refresh occurs*

 - Contact Tracing: *contact tracing has not yet been implemented*