Skip to content

taiphlosion/ChompIn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Chomp-In: QR-Based Attendance Tracking System 🐊📷

Chomp-In is a mobile application designed to streamline attendance tracking in educational settings. The application allows professors to generate QR codes for their classes, which students can scan to mark their attendance in real-time.

Features ✅

  • User Authentication: Secure login and registration system with role-based access (student/professor) 🪪
  • QR Code Generation: Professors can generate unique QR codes for each class session ⛶
  • Attendance Scanning: Students can scan QR codes to mark their attendance 🔎
  • Class Management: Professors can create and manage multiple classrooms 🎓
  • Attendance History: Track and view attendance records 🕰️

Tech Stack 🧑‍💻

Frontend 📱

  • React Native ⚛️
  • Expo Go
  • TypeScript #️⃣

Backend

  • Node.js and Express
  • PostgreSQL database 🖧
  • JWT for authentication 🔐

Project Structure

The project is organized into two main directories:

  • client/: Contains the React Native mobile application
  • server/: Contains the Express.js backend server

Setup Instructions

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Expo Go
  • Docker 🐳

Setup ⚙️

  • There are appropriate READMEs in both the client and server directory with more detailed instructions. 📂
  • If you are demoing on mobile, have a separate .env file in the client directory. Make a variable called API_URL formatted as: http://[IP address of your dev machine]:[your port but I just use 5000]
  • The server directory should have the .env file located at its root
  • I recommend having at least two terminals, one for the client and the server for server. 📟

Special thanks to Charlie Cummings for being our faculty advisor! 🤗

Feel free to follow us on our GitHub profiles and check us out on LinkedIn! 🌐 🤝

About

An attendance tracker application for students. Part of our senior project!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors