Adding example files for running locally with Uvicorn.

Author: carlosplanchon

.gitignore

@@ -138,5 +138,11 @@ cython_debug/
 
 # Config files:
 src/.env
-docker-compose.yml
-Dockerfile
+
+# Ignore root files:
+/Dockerfile
+/docker-compose.yml
+
+# Don't ignore files inside of script folder:
+!scripts/*
+

scripts/local_with_uvicorn/Dockerfile

@@ -0,0 +1,44 @@
+# --------- Builder Stage ---------
+FROM ghcr.io/astral-sh/uv:python3.11-bookworm-slim AS builder
+
+# Set environment variables for uv
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+
+WORKDIR /app
+
+# Install dependencies first (for better layer caching)
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project
+
+# Copy the project source code
+COPY . /app
+
+# Install the project in non-editable mode
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --no-editable
+
+# --------- Final Stage ---------
+FROM python:3.11-slim-bookworm
+
+# Create a non-root user for security
+RUN groupadd --gid 1000 app \
+    && useradd --uid 1000 --gid app --shell /bin/bash --create-home app
+
+# Copy the virtual environment from the builder stage
+COPY --from=builder --chown=app:app /app/.venv /app/.venv
+
+# Ensure the virtual environment is in the PATH
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Switch to the non-root user
+USER app
+
+# Set the working directory
+WORKDIR /code
+
+# -------- replace with comment to run with gunicorn --------
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]
+# CMD ["gunicorn", "app.main:app", "-w", "4", "-k", "uvicorn.workers.UvicornWorker", "-b", "0.0.0.0:8000"]

scripts/local_with_uvicorn/docker-compose.yml

@@ -0,0 +1,112 @@
+services:
+  web:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    # -------- Both of the following commands should be commented to run with nginx --------
+
+    # -------- replace with comment to run with gunicorn --------
+    command: uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
+    # command: gunicorn app.main:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000
+    env_file:
+      - ./src/.env
+    # -------- replace with expose if you are using nginx --------
+    ports:
+       - "8000:8000"
+    # expose:
+    #    - "8000"
+    depends_on:
+      - db
+      - redis
+    volumes:
+      - ./src/app:/code/app
+      - ./src/.env:/code/.env
+
+  worker:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    command: arq app.core.worker.settings.WorkerSettings
+    env_file:
+      - ./src/.env
+    depends_on:
+      - db
+      - redis
+    volumes:
+      - ./src/app:/code/app
+      - ./src/.env:/code/.env
+
+  db:
+    image: postgres:13
+    env_file:
+      - ./src/.env
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    expose:
+      - "5432"
+
+  redis:
+    image: redis:alpine
+    volumes:
+      - redis-data:/data
+    expose:
+      - "6379"
+
+  #-------- uncomment to run with nginx --------
+  # nginx:
+  #   image: nginx:latest
+  #   ports:
+  #     - "80:80"
+  #   volumes:
+  #     - ./default.conf:/etc/nginx/conf.d/default.conf
+  #   depends_on:
+  #     - web
+
+  #-------- uncomment to create first superuser --------
+  create_superuser:
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    env_file:
+      - ./src/.env
+    depends_on:
+      - db
+      - web
+    command: python -m src.scripts.create_first_superuser
+    volumes:
+      - ./src:/code/src
+
+  #-------- uncomment to run tests --------
+  pytest:
+    build: 
+      context: .
+      dockerfile: Dockerfile 
+    env_file:
+      - ./src/.env
+    depends_on:
+      - db
+      - create_superuser
+      - redis
+    command: python -m pytest ./tests
+    volumes:
+      - .:/code
+
+  #-------- uncomment to create first tier --------
+  # create_tier:
+  #   build: 
+  #     context: .
+  #     dockerfile: Dockerfile
+  #   env_file:
+  #     - ./src/.env
+  #   depends_on:
+  #     - create_superuser
+  #     - db
+  #     - web
+  #   command: python -m src.scripts.create_first_tier
+  #   volumes:
+  #     - ./src:/code/src
+
+volumes:
+  postgres-data:
+  redis-data:
+