Skip to content

vishnu1002/bunk-mate

Repository files navigation

FuseColor Logo

bunkmate.

REACT JS

Static Badge

bunkmate is a React-based web app designed to help college students manage their attendance effectively. The app calculates how many classes you can bunk without falling below a threshold attendance percentage (default 75%). Alternatively, if your attendance is below the threshold, it calculates the number of classes you need to attend to reach the desired percentage. BunkMate combines accurate calculations with an engaging user interface, making attendance tracking fun and hassle-free!

✨ Features

  • Customizable Attendance Percentage: Select from predefined thresholds (60%, 65%, 70%, etc.) to match your requirements.
  • Dynamic Calculations: Get real-time results based on the classes attended and total classes conducted.
  • Fun Responses: Enjoy witty and relatable messages for both bunking and attending results.
  • GIF Animations: Randomized GIFs add an extra touch of humor and engagement.

🚀 Deployment

🖥️ Local Setup:

  1. Clone the repository
https://github.com/vishnu1002/bunk-mate.git
cd bunk-mate
  1. Install dependencies
npm install
  1. Build project
npm build
  1. Run the app locally
npm run dev

🐳 Docker Setup:

  1. Clone the repository
https://github.com/vishnu1002/bunk-mate.git
cd bunk-mate
  1. Build and run the container
docker-compose up -d
  1. Stop the container
docker-compose down

Credits

bunkmate is developed and maintained by Vishnu

License

This project is licensed under the MIT License.

bunkmatesocial

Releases

No releases published

Packages

No packages published