CS462 Beep Beep Team Project

"Beep Beep", a team project for SPD Singapore and the CS462 Internet of Things (IoT) module at Singapore Management University.

Initiated in AY2021/2022 Term 1.

Introduction

Greetings, and welcome to the code repository for the Beep Beep project.

This project is an SMU-X industry project between Singapore Management University and SPD Singapore.

Background

This project uses IoT to solve a process-related challenge faced by SPD in tracking attendance and temperature scanning of its members during its events.

Meet the Team

Foo Chuan Geng
Kenneth Kho
Joshua Tseng
Jen Leng
Timothy Lim
Soh Ze Yu

Special thanks to Pius Lee for instruction and mentorship through CS462.

Technology

Software

Web stack: HTML, CSS, Javascript
Cloud: Google Firebase and Firestore

Hardware

Barcode Scanner (MH-ET Live Scanner)
IR Temperature sensor (MLX90614)
STSP buttons
3D printed chassis to house modules
Micro-controller (Arduino Nano)
LED

Collections

Collections are how Firebase and Firestore store values in its database. Each collection is similar to a table in a standard relational database.

The following are a list of collections that are used by the Beep Beep app to store data.

Collection: events

eventDocumentId: {
  eventName: “Name of Event”,
  startDateTime: date_time,
  duration: minutes_numerical,
  attendees: {
    attendeeId: {
      attendeeName: “person_name”,
      round1Attendance: Boolean,
      round2Attendance: Boolean,
      round1Temperature: 0,
round2Temperature: 0,
    },
  }
}

To run the application as a whole (In any linux Distro)

# first create project in your own firebase account 

npm install -g firebase-tools #install firebase cli

firebase login 

firebase projects:list # view list of project 

firebase use --add #add in firebase project  

firebase serve

Backend

cd beepbeep/functions 
npm install 
npm run serve # run local firestore and functions in emulator 
npm run deploy # deploy backend to production

Frontend

open beepbeep/public/index.html # To run only the frontend locally

firebase deploy --only hosting # deploy frontend to production

Frontend app Structure (under beepbeep/public/js folder)

component (UI logic)
routes (define routing changes on the app)
services (api and utilities functions)

joshtsengsh / cs462-beep-beep-team-project Goto Github PK