Merge pull request #230 from DogukanUrker/feat/docker-support

feat: add docker support

Author: DogukanUrker

.dockerignore

@@ -0,0 +1,13 @@
+# Exclude everything by default
+*
+
+# Include app directory
+!app
+
+# Exclude non-runtime files from app
+app/.venv
+app/.ruff_cache
+app/__pycache__
+app/.DS_Store
+app/log
+app/scripts

.gitignore

@@ -25,7 +25,6 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
-uv.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

AGENTS.md

@@ -11,6 +11,9 @@ make help          # Show all available commands
 make install       # Install all dependencies (app + dev + test + Playwright)
 make install-app   # Install app dependencies only
 make run           # Run the Flask application (http://localhost:1283)
+make docker        # Build and run with Docker
+make docker-build  # Build Docker image
+make docker-run    # Run Docker container
 make test          # Run E2E tests (parallel)
 make test-slow     # Run tests with visible browser (slow-mo, sequential)
 make lint          # Format and lint code (auto-fix)
@@ -67,6 +70,20 @@ Translations are JSON files in `app/translations/` (en, tr, es, de, zh, fr, uk,
 - **Post** - id, title, content, banner (binary), author, views, category, url_id, abstract, has `hot_score` hybrid property
 - **Comment** - id, post_id (FK), comment, username, time_stamp
 
+### Configuration
+
+All settings in `app/settings.py` are read from environment variables via `os.environ.get()` with sensible defaults. A `.env` file in the project root is loaded automatically by `python-dotenv`. See `.env.example` for all available options.
+
+Key settings: `APP_HOST`, `APP_PORT`, `DEBUG_MODE`, `SQLALCHEMY_DATABASE_URI`, `APP_SECRET_KEY`, `SMTP_*`, `DEFAULT_ADMIN_*`.
+
+### Docker
+
+- **Dockerfile** — Single-stage build using `ghcr.io/astral-sh/uv:python3.10-alpine`. Runs as non-root `flaskblog` user (UID 1000). Only production deps installed (`uv sync --frozen --no-dev --no-cache`).
+- **.dockerignore** — Whitelist approach: excludes everything (`*`), then includes only `app/` minus non-runtime files (`.venv`, `__pycache__`, `.ruff_cache`, `scripts`, `log`).
+- **Environment variables** — Not baked into the image. Passed at runtime via `docker run --env-file .env` (handled automatically by `make docker-run` if `.env` exists).
+- **Example DB** — `app/instance/flaskblog.db` is included in the image so the app starts with sample data.
+- **Ports** — Container binds to `0.0.0.0:1283` (overrides Flask's default `localhost` via `APP_HOST` env var).
+
 ### Key Conventions
 
 - Passwords hashed with Passlib's sha512_crypt

Dockerfile

@@ -0,0 +1,27 @@
+FROM ghcr.io/astral-sh/uv:python3.14-alpine
+
+RUN addgroup -g 1000 flaskblog && \
+    adduser -u 1000 -G flaskblog -D flaskblog
+
+WORKDIR /app
+
+RUN chown flaskblog:flaskblog /app
+
+USER flaskblog
+
+COPY --chown=flaskblog:flaskblog app/pyproject.toml app/uv.lock ./
+
+RUN uv sync --frozen --no-dev --no-cache && \
+    find .venv -type d -name tests -exec rm -rf {} + 2>/dev/null; true
+
+COPY --chown=flaskblog:flaskblog app/ .
+
+RUN mkdir -p instance log
+
+ENV PYTHONUNBUFFERED=1
+ENV APP_HOST=0.0.0.0
+ENV APP_PORT=1283
+
+EXPOSE 1283
+
+CMD ["uv", "run", "app.py"]

Makefile

@@ -6,7 +6,7 @@ UV := uv
 
 .DEFAULT_GOAL := help
 
-.PHONY: help install install-app run test test-slow lint ci clean
+.PHONY: help install install-app run docker docker-build docker-run test test-slow lint ci clean
 
 # Help
 help: ## Show all available commands
@@ -29,6 +29,17 @@ install-app: ## Install app dependencies only
 run: ## Run the Flask application (http://localhost:1283)
 	cd $(APP_DIR) && $(UV) run app.py
 
+# Docker
+docker: docker-build docker-run ## Build and run with Docker
+
+docker-build: ## Build Docker image
+	docker build -t flaskblog .
+
+docker-run: ## Run Docker container
+	docker run --rm -p 1283:1283 \
+		$(if $(wildcard .env),--env-file .env) \
+		flaskblog
+
 # Testing
 test: ## Run E2E tests (parallel)
 	cd $(APP_DIR) && $(UV) run pytest ../$(TESTS_DIR) -v

README.md

@@ -37,6 +37,29 @@ make run
 
 Visit `http://localhost:1283` in your browser.
 
+### Docker
+
+```bash
+make docker        # Build and run with Docker
+```
+
+Or step by step:
+
+```bash
+make docker-build  # Build the image
+make docker-run    # Run the container
+```
+
+### Configuration
+
+All settings can be configured via environment variables. Copy the example file and modify as needed:
+
+```bash
+cp .env.example .env
+```
+
+See [`.env.example`](.env.example) for all available options. When using Docker, the `.env` file is automatically passed to the container.
+
 ### Default Admin Account
 
 - Username: `admin`
@@ -59,6 +82,9 @@ make help          # Show all available commands
 make install       # Install all dependencies (app + dev + test + Playwright)
 make install-app   # Install app dependencies only
 make run           # Run the Flask application
+make docker        # Build and run with Docker
+make docker-build  # Build Docker image
+make docker-run    # Run Docker container
 make test          # Run E2E tests (parallel)
 make test-slow     # Run tests with browser visible (slow-mo)
 make lint          # Format and lint code (auto-fix)

app/utils/terminal_ascii.py

@@ -2,7 +2,9 @@ def terminal_ascii():
     """
     This function returns a string containing the terminal ASCII art.
     """
-    return """\033[38;2;244;63;94m
+    return (
+        "\033[38;2;244;63;94m"
+        + r"""
  /$$$$$$$$ /$$                     /$$       /$$$$$$$  /$$                     /$$    /$$  /$$$$$$
 | $$_____/| $$                    | $$      | $$__  $$| $$                    | $$   | $$ /$$__  $$
 | $$      | $$  /$$$$$$   /$$$$$$$| $$   /$$| $$  \ $$| $$  /$$$$$$   /$$$$$$ | $$   | $$|__/  \ $$
@@ -15,4 +17,6 @@ def terminal_ascii():
                                                                     |  $$$$$$/
                                                                      \______/
                                                                     by Doğukan Ürker
-    \033[0m"""
+    """
+        + "\033[0m"
+    )