Added Configuration UI and REST Endpoints (#28)

Author: dominiquekleeven

.github/workflows/ci.yml

@@ -26,16 +26,41 @@ jobs:
       with:
         version: "0.6.11"
 
-    - name: Create and activate Python virtual environment
+    - name: Create and activate virtual environment
       run: |
         uv venv
         source .venv/bin/activate
 
     - name: Run linting and type checking
       run: uv run lint
 
-    - name: Run tests
-      run: uv run test
+    - name: Run tests with coverage
+      run: uv run test-coverage
 
-    - name: Run build steps
+    - name: Run build
       run: uv run build
+
+  frontend-quality-checks:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
+      with:
+        node-version: '20'
+
+    - name: Install dependencies
+      run: npm install
+      working-directory: ./frontend
+
+    - name: Run linting
+      run: npm run lint
+      working-directory: ./frontend
+
+    - name: Build frontend
+      run: npm run build:prod
+      working-directory: ./frontend

Dockerfile

@@ -3,9 +3,7 @@
 [![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/)
 
 ## Installation
-This project uses [uv](https://docs.astral.sh/uv/) for project management. `uv` is a Python package and project manager that simplifies dependency management, environment creation, and running commands.
-
-For more information about uv, visit the [official documentation](https://docs.astral.sh/uv/).
+Follow the steps below to run the project.
 
 ### Prerequisites
 [uv](https://docs.astral.sh/uv/) - Python package and project manager
@@ -14,27 +12,64 @@ For more information about uv, visit the [official documentation](https://docs.a
 - Or install with pip: `pip install uv`
 - Or with Homebrew (macOS): `brew install uv`
 
-### Setup python environment
-`uv venv` automatically creates a virtual environment with the python version specified in the `pyproject.toml` file.
+[node](https://nodejs.org/en/download/) - JavaScript runtime + npm (node package manager)
+- Install with Homebrew (macOS): `brew install node`
+- Install directly (Windows): https://nodejs.org/en/download/
+- Install via apt (Linux): `sudo apt install nodejs npm`
+- Install via dnf (Linux): `sudo dnf install nodejs npm`
+- Install via pacman (Linux): `sudo pacman -S nodejs npm`
+
+***
 
+### Run the back-end (Python)
+
+Create a virtual environment
 ```bash
-# Create a virtual environment
+# In project root
 uv venv
 source .venv/bin/activate # On Windows: .venv\Scripts\activate
+
+uv sync
 ```
 
-### Install dependencies
+Set the required environment variables -- See [config.py](https://github.com/openremote/service-ml-forecast/blob/main/src/service_ml_forecast/config.py) for all configuration options.
 ```bash
-uv sync
+ML_OR_SERVICE_USER=serviceuser
+ML_OR_SERVICE_SECRET=secret
+```
+
+Start the back-end application
+```bash
+uv run start
+
+# Exposes the back-end on http://localhost:8000
+```
+
+***
+
+### Run the front-end (JavaScript)
+Serve the front-end
+```bash
+cd frontend
+npm run serve  # Automatically installs dependencies
+
+# Exposes the front-end on http://localhost:8001
 ```
 
-### Helper Scripts
-*Make sure you have created a virtual environment via `uv venv`*
+***
+
+### UV Helper Scripts
+In project root
 - Run linting - `uv run lint`
 - Format code - `uv run format`
 - Run tests - `uv run test`
 - Run the application - `uv run start`
 
+### NPM Helper Scripts
+in `/frontend`
+- Run linting - `npm run lint`
+- Format code - `npm run format`
+- Run the application - `npm run serve`
 
 ## License
 

README.md

@@ -0,0 +1,60 @@
+# Git
+.git
+.gitignore
+.github
+
+# Python
+__pycache__
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.nox/
+.hypothesis/
+
+# Node
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Environment
+.env
+.env.*
+!.env.example
+.venv
+venv/
+ENV/
+
+# Misc
+*.log
+*.sqlite
+*.db
+.DS_Store
+Thumbs.db 

docker/.dockerignore

@@ -0,0 +1,104 @@
+# --- Frontend Build Phase -----------------------------------------------------
+FROM node:20-slim AS frontend-builder
+
+RUN echo "Starting frontend build phase..."
+
+WORKDIR /app/frontend
+
+COPY frontend/package*.json ./
+RUN echo "Installing frontend dependencies..."
+RUN npm install
+
+COPY frontend/ ./
+
+# Define build arguments
+ARG ML_SERVICE_URL
+ARG ML_WEB_ROOT_PATH
+
+RUN ML_SERVICE_URL=${ML_SERVICE_URL:-/services/ml-forecast} \
+    ML_WEB_ROOT_PATH=${ML_WEB_ROOT_PATH:-/services/ml-forecast/ui} \
+    npm run build:prod
+
+# --- Python Build Phase -------------------------------------------------------
+FROM python:3.13-slim AS builder
+
+RUN echo "Starting Python build phase..."
+
+WORKDIR /app
+
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PIP_NO_CACHE_DIR=1 \
+    PIP_DISABLE_PIP_VERSION_CHECK=1 
+
+RUN echo "Installing Python build dependencies..."
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy project files
+COPY pyproject.toml README.md ./
+COPY src/ ./src/
+COPY scripts/ ./scripts/
+
+# Install project dependencies and clean up
+RUN echo "Installing Python project dependencies..."
+RUN pip install --no-cache-dir . \
+    && apt-get remove -y build-essential \
+    && apt-get autoremove -y \
+    && rm -rf /var/lib/apt/lists/* \
+    && find /usr/local/lib/python3.13 -type d -name '__pycache__' -exec rm -rf {} +
+
+# --- Runtime Phase ------------------------------------------------------------
+FROM python:3.13-slim
+
+RUN echo "Starting runtime phase setup..."
+
+WORKDIR /app
+
+# Explicitly declare the ARG for the build process
+ARG ML_ENVIRONMENT
+
+ENV PYTHONUNBUFFERED=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONPATH=/app/src \
+    # Use the ARG, falling back to a default if not provided during build or runtime
+    ML_ENVIRONMENT=${ML_ENVIRONMENT:-production}
+
+# Install runtime dependencies and clean up
+RUN echo "Installing runtime dependencies..."
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        curl \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy installed packages from builder
+RUN echo "Copying Python packages from builder..."
+COPY --from=builder /usr/local/lib/python3.13/site-packages/ /usr/local/lib/python3.13/site-packages/
+COPY --from=builder /usr/local/bin/ /usr/local/bin/
+
+# Copy application code
+COPY pyproject.toml ./
+COPY src/ ./src/
+COPY scripts/ ./scripts/
+
+# Copy frontend build and clean up
+RUN echo "Copying frontend build artifacts..."
+COPY --from=frontend-builder /app/frontend/dist/ ./deployment/web/dist/
+RUN rm -rf /app/frontend
+
+# Create deployment directories (config storage, model storage)
+RUN echo "Creating deployment directories..."
+RUN mkdir -p ./deployment/data/models ./deployment/data/configs
+
+# Expose port
+EXPOSE 8000
+
+# Add health check
+HEALTHCHECK --interval=5s --timeout=5s --start-period=30s --retries=3 CMD curl --fail --silent http://localhost:8000/ui || exit 1
+
+RUN echo "Container setup complete! Starting application..."
+
+# Run the application
+CMD ["python", "-m", "service_ml_forecast.main"]

docker/Dockerfile

@@ -0,0 +1,35 @@
+name: service-ml-forecast
+
+services:
+  service-ml-forecast:
+    build:
+      context: ..
+      dockerfile: docker/Dockerfile
+      args:
+        ML_SERVICE_URL: ${ML_SERVICE_URL:-/services/ml-forecast} # Url to reach the back-end service, should be the same as ML_API_ROOT_PATH
+        ML_WEB_ROOT_PATH: ${ML_WEB_ROOT_PATH:-/services/ml-forecast/ui} # Public path for the front-end (e.g. when behind a reverse proxy)
+    container_name: service-ml-forecast
+    ports:
+      - "8000:8000"
+    environment:
+      - ML_LOG_LEVEL=${ML_LOG_LEVEL:-INFO} # Log level to use
+      - ML_ENVIRONMENT=${ML_ENVIRONMENT:-production} # Environment to run the service in
+      - ML_API_ROOT_PATH=${ML_API_ROOT_PATH:-/services/ml-forecast} # Public path for the back-end (e.g. when behind a reverse proxy)
+      - ML_OR_URL=${ML_OR_URL:-http://host.docker.internal:8080} # OpenRemote URL
+      - ML_OR_KEYCLOAK_URL=${ML_OR_KEYCLOAK_URL:-http://host.docker.internal:8081} # OpenRemote Keycloak URL
+      - ML_OR_SERVICE_USER=${ML_OR_SERVICE_USER:-serviceuser} # OpenRemote service user
+      - ML_OR_SERVICE_USER_SECRET=${ML_OR_SERVICE_USER_SECRET:-secret} # OpenRemote service user secret
+    volumes:
+      # Model storage
+      - ../deployment/data/models:/app/deployment/data/models
+      # Config storage
+      - ../deployment/data/configs:/app/deployment/data/configs
+    restart: unless-stopped
+    networks:
+      - ml-network
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+networks:
+  ml-network:
+    driver: bridge

docker/docker-compose.yml

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?