Skip to content

QUICKSTART.md

Latest commit

 

History

History
117 lines (87 loc) · 2.33 KB

QUICKSTART.md

File metadata and controls

117 lines (87 loc) · 2.33 KB

🚀 Quick Start Guide

Get the Driver Monitoring System up and running in under 10 minutes!

Prerequisites Check

# Check Python version (need 3.8+)
python --version

# Check pip
pip --version

# Check git
git --version

5-Minute Setup

1. Clone & Navigate (30 seconds)

git clone https://github.com/yourusername/Driver_Monitoring_System.git
cd Driver_Monitoring_System

2. Install Dependencies (3 minutes)

# Create virtual environment
python -m venv venv

# Activate it
# Windows:
venv\Scripts\activate
# macOS/Linux:
source venv/bin/activate

# Install packages
pip install -r requirements.txt

3. Download Models (1 minute)

# YOLOv8 will auto-download on first run
# For custom models, see SETUP.md

4. Configure Alerts (2 minutes)

# Copy template
cp alert_system_template.py alert_system.py

# Edit alert_system.py with your credentials
# (Optional - skip for testing without alerts)

5. Run! (30 seconds)

python app.py

Visit: http://localhost:5000 🎉

Testing Without Alerts

You can test the detection features without setting up Twilio/Cloudinary:

# Comment out alert configuration in app.py
# configure_alerts()  # <-- Comment this line

Quick Test

  1. Open http://localhost:5000
  2. Click "Start Camera"
  3. Grant camera permission
  4. Try these tests:
    • ✅ Close eyes for 3 seconds → Drowsiness alert
    • ✅ Hold phone to ear → Phone detection
    • ✅ Cover mouth with hand → Hand on mouth

Common Quick Fixes

"ModuleNotFoundError"

pip install --upgrade pip
pip install -r requirements.txt

"Camera not found"

  • Check camera permissions
  • Close other apps using camera
  • Try different browser

"Model not found"

# Models will download automatically
# Or check models/ directory exists
mkdir models

What's Next?

  • 📖 Read SETUP.md for detailed setup
  • 🔒 Check SECURITY.md before pushing to GitHub
  • 🎯 Customize detection thresholds in app.py
  • 🚀 Deploy to cloud (see README.md)

Need Help?

Happy Monitoring! 🚗💨