FaceGuardV3 documentation

FaceGuardV3 is a local React + FastAPI + PostgreSQL face-recognition access indicator with liveness detection, dual browser/Raspberry-Pi camera modes, and optional GPIO LEDs. It has no physical door actuator.

Start here

• Repository setup, Raspberry Pi deployment, tests, and troubleshooting
• Customer handover
• Architecture
• Testing and QA
• Quality requirements and QRT status
• Definition of Done
• Contributing

Minimal browser-camera deployment

cp backend/.env.example backend/.env
python3 backend/scripts/generate_hash.py
openssl rand -hex 32
docker compose --env-file backend/.env \
  -f docker/docker-compose.yml up --build -d

Fill the generated bcrypt hash and JWT secret in backend/.env first. Open http://localhost:3000; backend health is http://localhost:8000/health. Raspberry Pi backend-camera/GPIO deployment requires both Compose files and explicit device/chip configuration as documented in the root README.

Warning

Never commit backend/.env. Normal CI does not prove physical camera behavior, real photo-attack rejection, or LED latency; consult the QRT page before interpreting test evidence.