Dockerize full stack app

.gitattributes

@@ -0,0 +1 @@
+*.sh text eol=lf

.gitignore

@@ -123,7 +123,7 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
+.env*
 .venv
 env/
 venv/
@@ -162,8 +162,10 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-dev/
+/dev/*
 .vscode/settings.json
 
 */node_modules/*
-records
+records
+
+/backend/alembic/versions/*.py

backend/.dockerignore

@@ -0,0 +1,2 @@
+Dockerfile
+/alembic/versions/*

.example_env → backend/.example_env

@@ -1,19 +1,17 @@
-# project envs
+# This file is used to set up the environment variables for the backend
+# This file should be copied to .env and edited with the correct values
+
 # Domain
 # This would be set to the production domain with an env var on deployment
 # used by Traefik to transmit traffic and aqcuire TLS certificates
 DOMAIN="localhost"
 # To test the local Traefik config
 # DOMAIN=localhost.tiangolo.com
 
-# Used by the backend to generate links in emails to the frontend
-FRONTEND_HOST="http://localhost:5173"
-# In staging and production, set this env var to the frontend host, e.g.
-# FRONTEND_HOST=https://dashboard.example.com
-
 # Environment: local, staging, production
 ENVIRONMENT="local"
 
+API_V1_STR="/api/v1"
 PROJECT_NAME="EmonTools"
 STACK_NAME="full-stack-emontools-project"
 
@@ -22,24 +20,19 @@ DATA_BASE_PATH="/opt/emon_tools/data"
 STATIC_BASE_PATH="/opt/emon_tools/static"
 
 # Backend
+# Used by the backend to generate links in emails to the frontend
+FRONTEND_HOST="http://localhost:5173"
+# In staging and production, set this env var to the frontend host, e.g.
+# FRONTEND_HOST=https://dashboard.example.com
 BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173"
-SECRET_KEY= 
-FIRST_SUPERUSER=admin@example.com
+
+SECRET_KEY=changethis
+FIRST_SUPERUSER=changethis
 FIRST_SUPERUSER_PASSWORD=changethis
 
 # Mysql
-MYSQL_SERVER="127.0.0.1"
+MYSQL_HOST="127.0.0.1"
 MYSQL_PORT=3306
-MYSQL_DB="app"
+MYSQL_DB="emontools"
 MYSQL_USER="emontools"
 MYSQL_PASSWORD=changethis
-
-# EmonCms envs
-# local emoncms instance
-EMONCMS_URL="http://127.0.0.1:8080"
-# emoncms apikey
-API_KEY=changethis
-# local phpfina paths
-EMON_FINA_PATH="/var/lib/phpfina"
-# phpfina archives directory
-ARCHIVE_FINA_PATH="./datas"

backend/.example_env_docker

@@ -0,0 +1,38 @@
+# This file is used to set up the environment variables for the backend
+# This file should be copied to .env.docker and edited with the correct values
+
+# Domain
+# This would be set to the production domain with an env var on deployment
+# used by Traefik to transmit traffic and aqcuire TLS certificates
+DOMAIN="localhost"
+# To test the local Traefik config
+# DOMAIN=localhost.tiangolo.com
+
+# Environment: local, staging, production
+ENVIRONMENT="local"
+
+API_V1_STR="/api/v1"
+PROJECT_NAME="EmonTools"
+STACK_NAME="full-stack-emontools-project"
+
+# Data Path
+DATA_BASE_PATH="/opt/emon_tools/data"
+STATIC_BASE_PATH="/opt/emon_tools/static"
+
+# Backend
+# Used by the backend to generate links in emails to the frontend
+FRONTEND_HOST="http://localhost:5173"
+# In staging and production, set this env var to the frontend host, e.g.
+# FRONTEND_HOST=https://dashboard.example.com
+BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173"
+
+SECRET_KEY=changethis
+FIRST_SUPERUSER=changethis
+FIRST_SUPERUSER_PASSWORD=changethis
+
+# Mysql
+MYSQL_HOST="127.0.0.1"
+MYSQL_PORT=3306
+MYSQL_DB="emontools"
+MYSQL_USER="emontools"
+MYSQL_PASSWORD=changethis

backend/Dockerfile

@@ -0,0 +1,65 @@
+# Use Python 3.11 slim base image
+FROM python:3.11-slim
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1 \
+    # Add the local user's bin directory to PATH
+    PATH="/home/appuser/.local/bin:$PATH"
+
+# Create a non-root user and group
+RUN groupadd --gid 1000 appuser && \
+    useradd --uid 1000 --gid appuser --create-home appuser
+
+# Set working directory
+WORKDIR /opt/emon_tools
+
+# Install build dependencies if needed (e.g., for any compiled packages)
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    dos2unix \
+    default-mysql-client \
+    python3-dev \
+    default-libmysqlclient-dev \
+    build-essential \
+    pkg-config \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy requirements and install them as the non-root user
+COPY --chown=appuser:appuser requirements-docker-dev.txt .
+
+# Create the datas and static directories for storing data
+RUN mkdir -p /opt/emon_tools/datas /opt/emon_tools/static  /opt/emon_tools/backend \
+    && chown -R appuser:appuser /opt/emon_tools/datas /opt/emon_tools/static /opt/emon_tools/backend
+
+# Switch to the non-root user
+USER appuser
+
+# Install Python dependencies
+# Use --no-cache-dir to avoid caching the packages in the image
+# Use --user to install packages in the user's home directory
+RUN pip install --no-cache-dir --user --upgrade pip && \
+    pip install --no-cache-dir --user -r requirements-docker-dev.txt
+
+# Copy the backend source code
+COPY --chown=appuser:appuser . ./backend
+
+# Replace env file with the one for Docker
+COPY --chown=appuser:appuser .env.docker ./backend/.env
+
+RUN dos2unix /opt/emon_tools/backend/scripts/docker_start.sh
+RUN dos2unix /opt/emon_tools/backend/scripts/pre_start.sh
+RUN dos2unix /opt/emon_tools/backend/scripts/wait_for_db.sh
+
+# Ensure scripts have execution permission
+RUN chmod +x /opt/emon_tools/backend/scripts/docker_start.sh \
+    && chmod +x /opt/emon_tools/backend/scripts/pre_start.sh \
+    && chmod +x /opt/emon_tools/backend/scripts/wait_for_db.sh
+
+# Set the PYTHONPATH to ensure the backend module is found
+ENV PYTHONPATH=/opt/emon_tools
+
+# Expose FastAPI port (use 8000)
+EXPOSE 8000
+
+# Use the entrypoint script as CMD, which will run migrations and then launch uvicorn
+CMD ["./backend/scripts/docker_start.sh"]

backend/alembic.ini

@@ -3,7 +3,7 @@
 [alembic]
 # path to migration scripts
 # Use forward slashes (/) also on windows to provide an os agnostic path
-script_location = ./emon_tools/fastapi/alembic
+script_location = ./backend/alembic
 
 # template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
 # Uncomment the line below if you want the files to be prepended with date and time