Skip to content

README.md

Latest commit

 

History

History
123 lines (76 loc) · 3.99 KB

README.md

File metadata and controls

123 lines (76 loc) · 3.99 KB

🎉 QuickCheck - The Ultimate Attendance Management Tool 🎉

Welcome to QuickCheck! QuickCheck aims to be your go-to solution for smooth, reliable, and secure attendance management, but that's not all! Alongside attendance, QuickCheck brings together group chat and a schedule event—all in one perfect tool for classrooms! 🏫🎒

✨ Key Features

1. 📋 Reliable & Secure Attendance

  • QuickCheck offers seamless attendance tracking with high security and ease of use.
  • ✅ Professors can start attendance sessions, and students check in quickly with geolocation and session codes.
  • 🔐 Privacy-first approach: Only those in the right location can mark themselves as present!

2. 💬 Group Chat

  • Connect and communicate with classmates or professors in real-time!
  • Organized Channels for each class ensure focused discussions. No more cluttered chats! 💬✨
  • Exchange ideas, share files, and get the latest announcements all in one place.

3. 📅 Schedule Calendar

  • A shared event for scheduling classes, assignments, and important deadlines.
  • Color-coded events help students and teachers stay organized at a glance. 🌈🗓️
  • Never miss a beat—QuickCheck keeps everyone on track!

🌕 Why QuickCheck?

QuickCheck combines essential classroom features—attendance, communication, and scheduling—into one efficient, easy-to-use platform. 🧑‍🏫👩‍🎓 Perfect for students and teachers alike, QuickCheck is designed to:

  • Save time ⏳ (No more manual roll calls!)
  • Enhance communication 📢
  • Organize schedules 📌

QuickCheck = Attendance + Communication + Schedule Management
📚 A perfect blend for today’s dynamic classrooms!

🚀 Getting Started

Follow these simple steps to set up QuickCheck :

🎥 Quick Demos

🔐 Easy Attendance Check-In

Attendance Demo

💬 Group Chat in Action

Group Chat Demo

📅 Scheduling and Organizing with the Calendar

Calendar Demo

🛠 Configuration

QuickCheck offers flexible configuration options to suit your classroom needs:

  • Database: QuickCheck uses PostgreSQL by default. Ensure your connection is set up in application.yml.
  • Authentication: Integrated with JWT to keep access secure and reliable.
  • Notifications: Enable email notifications for reminders and important updates.

🤝 Contributing

We welcome contributions from the community! Here’s how you can get involved:

  1. 🍴 Fork the repository.
  2. 🌿 Create a new branch (feature/your-feature-name).
  3. 🔧 Make your changes.
  4. 📝 Test your changes.
  5. 📥 Open a pull request.

Check out the CONTRIBUTING.md for further details.

📚 Documentation

For complete documentation on all API endpoints, database models, and more, please visit the Wiki section of this repository. 📖

💻 Tech Stack

QuickCheck is powered by the following technologies:

  • Frontend: React, Axios
  • Backend: Spring Boot, Spring Security PostgreSQL
  • Cloud: AWS EC2, Amplify, RDS, S3

🔧 Tech Tools

QuickCheck relies on the following tools:

  • UI/UX: Chakra UI, Figma
  • CI/CD: GitHub Actions, Docker Hub
  • Database Migration: Flyway DB
  • Testing: JUnit, Surefire, Postman
  • App Hosting: AWS ALB, VPC, Route53

📬 Get in Touch!

Have questions or suggestions? Reach out on our Discussion Board or email us at quickcheckteam@gmail.com. We’d love to hear from you! 👂💡

❤️ Support

If QuickCheck has made managing your classroom easier, please give us a star ⭐ and share it with others!

With QuickCheck, your classroom is smoother, communication is clearer, and schedules are perfectly organized. Let’s make education easier—together. 🌟