Merge pull request #25 from Materials-Data-Science-and-Informatics/enhancement/dockerize-app

Updated version of the app

Author: mustafasoylu

.dockerignore

@@ -0,0 +1,82 @@
+# .dockerignore - Excludes files from Docker build context
+# Reduces build time, image size, and prevents leaking sensitive data
+
+# Version control
+.git/
+.gitignore
+.github/
+
+# Python cache and compiled files
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.pytest_cache/
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.poetry/
+
+# Environment variables (SECURITY: never include secrets in images)
+.env
+.env.*
+
+# Documentation
+# Keep README.md for Poetry package installation
+# *.md  # Commented out to allow README.md
+docs/
+LICENSE
+
+# Development and testing
+.pre-commit-config.yaml
+.ropeproject/
+tests/
+test_*.py
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Docker files (don't need these inside the image)
+Dockerfile
+Dockerfile.*
+docker-compose.yml
+docker-compose.*.yml
+.dockerignore
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+
+# Logs
+*.log
+logs/
+
+# OS files
+.DS_Store
+Thumbs.db
+Desktop.ini
+
+# Temporary files
+*.tmp
+*.temp
+tmp/
+temp/
+
+# Coverage reports
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+*.cover
+.hypothesis/

.env.example

@@ -0,0 +1,75 @@
+# Environment Variables Template for Survey Dashboard
+# Copy this file to .env and update with your actual values
+# Command: cp .env.example .env
+
+# ============================================================================
+# Docker Compose Configuration
+# ============================================================================
+
+# Project name - used as prefix for container names
+# Example: survey-dashboard_nginx_1, survey-dashboard_dashboard_1
+COMPOSE_PROJECT_NAME=survey-dashboard
+
+# ============================================================================
+# Application Configuration
+# ============================================================================
+
+# Port the Panel application runs on inside the container
+# Default: 5006 (Panel's default port)
+APP_PORT=
+
+# ============================================================================
+# Nginx Configuration
+# ============================================================================
+
+# Port nginx exposes on the host machine
+# Default: 80 (standard HTTP port), 443 (standard HTTPS port)
+# Change to 8080/8443 if 80/443 are already in use
+NGINX_PORT=
+
+# Your domain name
+# IMPORTANT: For HTTPS to work, this MUST be a real domain that points to your server
+# In development: Use 'localhost' (HTTPS won't work, only HTTP)
+# In production: Use your actual domain (e.g., survey.example.com)
+# This domain is used by:
+#   - nginx-proxy: Routes traffic from this domain to the dashboard
+#   - acme-companion: Requests SSL certificate for this domain from Let's Encrypt
+HOST=
+
+# Path on the domain where the dashboard is accessible
+# If set, the dashboard will ONLY be accessible at this specific path
+# Examples:
+#   - VIRTUAL_PATH=/survey-dashboard → https://your-domain.com/survey-dashboard
+#   - VIRTUAL_PATH=/dashboard → https://your-domain.com/dashboard
+#   - Leave empty for root path → https://your-domain.com/
+# IMPORTANT: Must start with / (forward slash)
+# All other paths on this domain will return 404
+VIRTUAL_PATH=
+
+# ============================================================================
+# SSL/HTTPS Configuration (Let's Encrypt)
+# ============================================================================
+
+# Your email address for Let's Encrypt certificate registration
+# REQUIRED for production HTTPS deployment
+# Let's Encrypt uses this email to:
+#   - Send certificate expiration warnings (if auto-renewal fails)
+#   - Send security notices about your certificates
+#   - Contact you about your Let's Encrypt account
+# Example: admin@example.com or your-email@gmail.com
+LETSENCRYPT_EMAIL=
+
+# ============================================================================
+# Python Configuration
+# ============================================================================
+
+# Keep Python output unbuffered for better logging
+PYTHONUNBUFFERED=1
+
+# ============================================================================
+# NOTES
+# ============================================================================
+# - Never commit the .env file to version control
+# - .env is listed in .gitignore to prevent accidental commits
+# - Update .env.example when adding new environment variables
+# - In production, consider using Docker secrets or a secrets manager

.env.local.example

@@ -0,0 +1,83 @@
+# Environment Variables for LOCAL TESTING
+# Copy this file to .env.local for local Docker testing
+# Command: cp .env.local.example .env.local
+
+# IMPORTANT: This is for LOCAL TESTING ONLY
+# For production deployment, use .env.example instead
+
+# ============================================================================
+# Docker Compose Configuration
+# ============================================================================
+
+# Project name - use different name to avoid conflicts with production
+COMPOSE_PROJECT_NAME=survey-dashboard-local
+
+# ============================================================================
+# Application Configuration
+# ============================================================================
+
+# Port the Panel application runs on inside the container
+APP_PORT=5006
+
+# ============================================================================
+# Nginx Configuration
+# ============================================================================
+
+# Port nginx exposes on the host machine
+# Default: 80 for HTTP
+# If port 80 is in use, change to 8080 or another available port
+NGINX_PORT=80
+
+# Domain name - use localhost for local testing
+# IMPORTANT: HTTPS will NOT work with localhost (Let's Encrypt requires real domains)
+# You can only test HTTP locally
+HOST=localhost
+
+# Path on the domain where the dashboard is accessible
+# Test the same path you'll use in production
+# Example: VIRTUAL_PATH=/2021community
+# Leave empty to serve from root: http://localhost/
+VIRTUAL_PATH=/2021community
+
+# ============================================================================
+# SSL/HTTPS Configuration (Let's Encrypt)
+# ============================================================================
+
+# Dummy email for local testing
+# This is not used when HOST=localhost (Let's Encrypt won't run)
+# In production, use a real email address
+LETSENCRYPT_EMAIL=test@localhost
+
+# ============================================================================
+# Python Configuration
+# ============================================================================
+
+# Keep Python output unbuffered for better logging
+PYTHONUNBUFFERED=1
+
+# ============================================================================
+# LOCAL TESTING NOTES
+# ============================================================================
+
+# What works locally:
+# ✅ Docker build and container startup
+# ✅ HTTP access at http://localhost/2021community
+# ✅ Path routing and restrictions
+# ✅ WebSocket connections
+# ✅ Dashboard interactivity
+# ✅ Container restarts and rebuilds
+
+# What does NOT work locally:
+# ❌ HTTPS/SSL certificates (requires real domain)
+# ❌ Let's Encrypt certificate acquisition (localhost is not valid)
+# ❌ External access from internet (only local machine)
+
+# How to test:
+# 1. Copy this file: cp .env.local.example .env.local
+# 2. Start containers: docker-compose --env-file .env.local up -d --build
+# 3. Test in browser: http://localhost/2021community
+# 4. Follow LOCAL_TESTING.md for detailed testing scenarios
+
+# Cleanup after testing:
+# docker-compose --env-file .env.local down
+# docker-compose --env-file .env.local down -v  # Remove volumes too

.gitignore

@@ -1,5 +1,6 @@
 # custom
-*.csv
+responses_cleaned_mapped_to_publish.csv
+#survey_dashboard/hmc_layout/static/en_files/fonts/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -106,13 +107,17 @@ celerybeat.pid
 
 # Environments
 .env
+.env.local
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
 
+# Deployment files (may contain sensitive server info)
+DEPLOYMENT.md
+
 # Spyder project settings
 .spyderproject
 .spyproject
@@ -130,3 +135,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+
+# Claude
+.claude/

Dockerfile

@@ -0,0 +1,44 @@
+# Multi-stage build for survey dashboard
+# Stage 1: Builder - installs dependencies
+FROM python:3.12-slim as builder
+
+# Install poetry
+RUN pip install --no-cache-dir poetry==1.8.2
+
+WORKDIR /app
+
+# Copy dependency files first (for Docker layer caching)
+COPY pyproject.toml poetry.lock README.md ./
+
+# Configure poetry to not create virtual environment (we're in a container)
+RUN poetry config virtualenvs.create false
+
+# Install dependencies (excluding dev dependencies)
+# --no-root: Don't install the project itself, only dependencies
+RUN poetry install --only main --no-root --no-interaction --no-ansi
+
+# Stage 2: Final runtime image
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Copy installed packages from builder stage
+COPY --from=builder /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/site-packages
+COPY --from=builder /usr/local/bin /usr/local/bin
+
+# Copy application code
+COPY survey_dashboard/ ./survey_dashboard/
+COPY pyproject.toml ./
+
+# Create a non-root user for security
+RUN useradd -m -u 1000 appuser && \
+    chown -R appuser:appuser /app
+
+USER appuser
+
+# Expose the application port
+EXPOSE 5006
+
+# Run the application in production mode
+# Use python -m to run the module directly since we installed with --no-root
+CMD ["python", "-m", "survey_dashboard.scripts", "--production", "--host", "0.0.0.0", "--port", "5006"]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Materials Data Science and Informatics
+Copyright (c) 2025 Materials Data Science and Informatics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal