The official service is Django + Django REST Framework on port 8084, backed
by PostgreSQL. main.py is the historical Session 01 FastAPI exercise; it is
preserved as course evidence and is not the service entry point. Do not use
uvicorn main:app to run S4-RSK.
Requirements: Python 3.12, Docker Desktop with Linux containers, Git.
py -3.12 -m venv .venv
.\.venv\Scripts\python.exe -m pip install -r requirements.txt
Copy-Item s4_rsk/.env.example s4_rsk/.env
docker compose up -d s4-rsk-db
.\.venv\Scripts\python.exe s4_rsk/manage.py migrate
.\.venv\Scripts\python.exe s4_rsk/manage.py runserver 127.0.0.1:8084Copy the env template only on first setup; preserve an existing local .env.
For macOS/Linux use python3.12 -m venv .venv, cp and .venv/bin/python.
The template credentials are for local development only. Never commit .env.
Both Compose services read s4_rsk/.env, so database name, user and password
come from the same file. Host Django uses localhost:5434; container Django
overrides only the network address to s4-rsk-db:5432. Keep the sample host
port at 5434. Do not rely on a root .env to configure the database.
If a pre-existing volume was initialized with different credentials, changing the env file does not rename its existing PostgreSQL role. Preserve that data and use matching credentials or arrange a deliberate database migration.
docker compose up --build -d
docker compose psThe entrypoint applies migrations then starts Gunicorn on 8084. Do not run the
host server and container server on the same port at the same time. Stop with
docker compose stop; restart with docker compose start. Do not use
docker compose down -v when you need to preserve the database.
curl.exe -i http://127.0.0.1:8084/health
curl.exe -i http://127.0.0.1:8084/ready
.\.venv\Scripts\python.exe scripts/verify_health.pyGET /health returns 200 {"status":"UP","service":"s4-rsk"} without querying
the database. /ready queries PostgreSQL and returns
200 {"status":"READY","service":"s4-rsk","database":"CONNECTED"} or
503 application/problem+json. Both probes are public. Responses include
X-Correlation-ID. Swagger is /api/docs/; schema is /api/schema/.
API endpoints use Bearer JWT; Django admin retains session authentication.
The risk-rule list requires group manager, while assessment endpoints require
the separate payment_service group. See JWT instructions
and the draft S3 contract. Production requires
HTTPS, a strong SECRET_KEY, a distinct JWT_SIGNING_KEY, shared rate-limiting,
secure deployment settings, and agreement with S3 on service identity.
Use a dedicated test database/server; pytest creates a test_ database and
requires a PostgreSQL role with CREATEDB. Never point it at shared data.
$env:POSTGRES_DB = 's4_rsk_test'
$env:POSTGRES_USER = 's4_rsk_user'
$env:POSTGRES_PASSWORD = 's4_rsk_password'
$env:POSTGRES_HOST = '127.0.0.1'
$env:POSTGRES_PORT = '15434'
$env:DEBUG = 'True'
docker run -d --name s4-rsk-ali-test-db -e POSTGRES_DB=s4_rsk_test -e POSTGRES_USER=s4_rsk_user -e POSTGRES_PASSWORD=s4_rsk_password -p 127.0.0.1:15434:5432 --tmpfs /var/lib/postgresql/data postgres:16-alpine
Set-Location s4_rsk
..\.venv\Scripts\python.exe manage.py check
..\.venv\Scripts\python.exe manage.py makemigrations --check --dry-run
..\.venv\Scripts\python.exe -m pytest
..\.venv\Scripts\python.exe manage.py spectacular --validate --fail-on-warn --file ../contracts/openapi.yaml
..\.venv\Scripts\ruff.exe check .If that test container already exists, start it rather than running docker run
again. The tmpfs database is disposable and does not use the project's data
volume. Remove the test-only environment overrides or open a fresh terminal
before returning to the development service.
Frontend scaffolding and persistent idempotency remain separate work items; their existence is not implied by this backend baseline.