Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 1.89 KB

README.md

File metadata and controls

80 lines (55 loc) · 1.89 KB
Raw

Build Status Coverage Status dependencies Status

Automated Attendance

A facial recognition based automated attendance system for Hack Reactor students and staff. automatedattendance.herokuapp.com"

Team

  • Jason Chambers
  • Han Zhao
  • Duy Nguyen
  • Andrew Alonis

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
  4. Roadmap
  5. Contributing

Usage

Students sign in with GitHub to create an account. Administrators control enrollment, attendance scheduling and editing. Attendance is recorded when students are recognized walking through the front door. Students receive confirmation emails and late notices.

Requirements

  • Node 6.4.x
  • etc
  • etc

Development

Installing Dependencies

From within the root directory:

npm install -g bower
npm install
bower install

Local development

npm run build
npm run s

Testing

npm test

Then view code coverage by opening ~/coverage/report/index.html ßß

Technology

  • React, NodeJS, ExpressJS, MySQL
  • Kairos API (facial recoginition)
  • Cloudinary API (photo storage)
  • Mailgun API (emails)
  • OAuth API (accounts)

Contributing

See CONTRIBUTING.md for contribution guidelines.