Skip to content

AhmadM-DL/aub_kure

Repository files navigation

🩺 Kure

Docker Compose CI/CD

Kure is a mental health support platform designed to help individuals track and understand their emotional well-being through voice. By simply sending WhatsApp voice notes, users can record their thoughts, which are then transcribed, analyzed, and stored using AI. Kure detects emotional patterns, tracks mood shifts, and flags signs of suicidal ideation—empowering users and therapists with meaningful insights to support ongoing mental health care.

💡 Functionality

  • Interfaced using whatsapp so you can communicate your thoughts easily!
  • Transcribe your voice through state of the art AI models.
  • State of the art suicide detection language model.
  • State of the art emotion detection language model based on a sound emotion lexicon.
  • Access your notes easily using a simple web interface.
  • Dashboard to monitor your mood.

⚙️ Architecture

⬇️ Deployment Docker

  • Clone the repositroy (Use releases)
  • 🔐 Create a secrets folder in the repo and including the following files/secrets:
    • backend_secret.txt (Django App Secret - Used For Hashing)
    • db_password.txt
    • db_user.txt
    • handshake_secret.txt (Whatsapp Handshake Secret)
    • whatsapp_secret.text (Whatsapp API Key)
    • N.B. for convenience the secrets are stored in github
  • Compose
    • docker-compose up -d --build
  • Build database
    • docker exec aub_kure-backend-1 python manage.py migrate
  • Download Models
    • docker exec aub_kure-mood-tracker-1 python download.py
    • docker exec aub_kure-speech-to-text-1 python download.py
    • docker exec aub_kure-suicide-detection-1 python download.py
  • Expose Whatsapp service through ngrok (Whatsapp requires HTTPS endpoint) in the background
    • ngrok http --url=your-domain 5003 > /dev/null &
  • Open localhost:80 to access the web application

Deployment K8s

  • Clone the repositroy (Use releases)
  • 🔐 Create a secrets folder in kure-kustomize-deployment/overlays/production/ and including the following files:
    • backend_secret.txt (Django App Secret - Used For Hashing)
    • db_password.txt
    • db_user.txt
    • handshake_secret.txt (Whatsapp Handshake Secret)
    • whatsapp_secret.text (Whatsapp API Key)
    • N.B. for convenience the secrets are stored in github
  • Build
    • kubectl apply -k kure-kustomize-deployment/overlays/production
  • Make sure all images are pulled and pods are in Running state
    • kubectl get pods
  • Build database
    • kubectl exec deployment/backend -- python manage.py migrate
  • Download Models
    • kubectl exec deployment/mood-tracker -- python download.py
    • kubectl exec deployment/speech-to-text -- python download.py
    • kubectl exec deployment/suicide-detection -- python download.py
  • Expose Whatsapp service through ngrok (Whatsapp requires HTTPS endpoint) in the background
    • ngrok http --url=your-domain 30015 > /dev/null &
  • Open localhost:30014 to access the web application

▶️ Deployment Endpoints

🛝 Slides

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •