Segmind MVP - Customer Messaging Platform

A modern customer messaging and segmentation platform with multi-channel support (SMS, Email, WhatsApp, Push).

Quick Start - Two Ways to Run

Option 1: Using Docker (Recommended - No Setup Required!)

Requirements

• Docker Desktop installed (Download here)

Run with Docker

Windows:

start-docker.bat

Mac/Linux:

./start-docker.sh

That's it! Docker handles everything:

• ✅ No Python version issues
• ✅ No Node.js version issues
• ✅ No venv problems
• ✅ No dependency conflicts
• ✅ Works the same on every machine

Visit http://localhost:3000 after containers start.

Option 2: Run Locally with Python

Requirements

• Python 3.7+ installed
• Node.js 14+ installed

Run Locally

python run.py

Then choose option 2.

Note: If you're having issues with the Python script (infinite loops, venv problems), use Docker instead!

Why Docker is Better

With Docker:

• Zero Setup: Just install Docker and run
• No Python/Node Version Conflicts: Container has the right versions
• No Venv Issues: Everything runs in isolated containers
• Cross-Platform: Same command works on Windows, Mac, Linux
• Clean System: Nothing installed on your machine
• Easy Cleanup: Just stop containers and delete them

Docker Commands

Start the app:

docker-compose up

Stop the app:

docker-compose down

Rebuild after code changes:

docker-compose up --build

View logs:

docker-compose logs backend
docker-compose logs frontend

Clean everything:

docker-compose down -v --remove-orphans

URLs

Once running, access:

• Frontend Dashboard: http://localhost:3000
• Backend API: http://localhost:8000
• API Documentation: http://localhost:8000/docs

Features

• 📊 Real-time customer segmentation
• 📨 Multi-channel messaging (SMS, Email, WhatsApp, Push)
• 📈 Analytics and ROI tracking
• 🎯 Targeted campaign management
• 🔄 Real-time metrics dashboard
• 🚀 Fast, modern tech stack (FastAPI + Next.js)
• 📧 Email generation from analytics

Customer Segments

The platform tracks 5 key customer segments:

• High Converters (6.5%) - Premium customers with high conversion rates
• Window Shoppers (35.4%) - High browse rate, low purchase rate
• Cart Abandoners (20.3%) - Started checkout but didn't complete
• Loyal Customers (9.7%) - Repeat purchasers
• At Risk (28.1%) - Haven't engaged recently

Project Structure

.
├── segmind/
│   ├── backend/
│   │   ├── main.py              # FastAPI entrypoint
│   │   ├── requirements.txt     # Backend dependencies
│   │   ├── routes/
│   │   │   ├── analytics.py     # Analytics endpoints
│   │   │   └── segments.py      # Customer segments endpoints
│   │   └── tests/               # Backend tests
│   └── frontend/                # Next.js frontend application
├── docker-compose.yml           # Docker orchestration
├── Dockerfile.backend           # Backend container config
├── Dockerfile.frontend          # Frontend container config
├── start-docker.sh              # Unix Docker starter
├── start-docker.bat             # Windows Docker starter
└── .env                         # Environment configuration

Troubleshooting

Docker Issues

1. Make sure Docker Desktop is running
2. Check ports 3000 and 8000 are free
3. Try docker-compose down then docker-compose up --build

Local Python Issues

1. If venv loops infinitely → Use Docker instead
2. If dependencies fail → Use Docker instead
3. If versions conflict → Use Docker instead

Key Metrics Displayed

• Total Messages: 156,789 messages sent
• Total Customers: 44,054 tracked customers
• Revenue Attributed: $2,847,593.45
• Engagement Rate: 24.7% average
• Channel Performance: ROI by channel (SMS, Email, WhatsApp, Push)

Development

The app auto-reloads on code changes:

• Backend: Edit backend_api.py and it auto-reloads
• Frontend: Edit files in segmind/frontend/ and it auto-reloads

No need to restart containers!# Contribution test - PatrickGaied