feat(docs): codebase refactor - added src directory

.github/workflows/build-image.yaml

@@ -15,7 +15,7 @@ on:
       context:
         description: "Docker build context path"
         required: false
-        default: "7project/backend"
+        default: "7project/src/backend"
         type: string
       pr_number:
         description: "PR number (required when mode=pr)"

.github/workflows/deploy-pr.yaml

@@ -21,7 +21,7 @@ jobs:
     with:
       mode: pr
       image_repo: lukastrkan/cc-app-demo
-      context: 7project/backend
+      context: 7project/src/backend
       pr_number: ${{ github.event.pull_request.number }}
     secrets: inherit
 
@@ -33,7 +33,7 @@ jobs:
       runner: vhs
       mode: pr
       pr_number: ${{ github.event.pull_request.number }}
-      base_domain: ${{ vars.DEV_BASE_DOMAIN }}
+      base_domain: ${{ vars.PROD_DOMAIN }}
     secrets: inherit
 
   frontend:
@@ -77,7 +77,7 @@ jobs:
 
       - name: Helm upgrade/install PR preview
         env:
-          DEV_BASE_DOMAIN: ${{ secrets.BASE_DOMAIN }}
+          DEV_BASE_DOMAIN: ${{ vars.BASE_DOMAIN }}
           RABBITMQ_PASSWORD: ${{ secrets.PROD_RABBITMQ_PASSWORD }}
           DB_PASSWORD: ${{ secrets.PROD_DB_PASSWORD }}
           DIGEST: ${{ needs.build.outputs.digest }}
@@ -90,9 +90,9 @@ jobs:
           PR=${{ github.event.pull_request.number }}
           RELEASE=myapp-pr-$PR
           NAMESPACE=pr-$PR
-          helm upgrade --install "$RELEASE" ./7project/charts/myapp-chart \
+          helm upgrade --install "$RELEASE" ./7project/src/charts/myapp-chart \
             -n "$NAMESPACE" --create-namespace \
-            -f 7project/charts/myapp-chart/values-dev.yaml \
+            -f 7project/src/charts/myapp-chart/values-dev.yaml \
             --set prNumber="$PR" \
             --set deployment="pr-$PR" \
             --set domain="$DOMAIN" \

.github/workflows/deploy-prod.yaml

@@ -4,9 +4,9 @@ on:
   push:
     branches: [ "main" ]
     paths:
-      - 7project/backend/**
+      - ../../7project/src/backend/**
-      - 7project/frontend/**
+      - ../../7project/src/frontend/**
-      - 7project/charts/myapp-chart/**
+      - ../../7project/src/charts/myapp-chart/**
       - .github/workflows/deploy-prod.yaml
       - .github/workflows/build-image.yaml
       - .github/workflows/frontend-pages.yml
@@ -32,7 +32,7 @@ jobs:
     with:
       mode: prod
       image_repo: lukastrkan/cc-app-demo
-      context: 7project/backend
+      context: 7project/src/backend
     secrets: inherit
 
   get_urls:
@@ -103,9 +103,9 @@ jobs:
           SMTP_FROM: ${{ secrets.SMTP_FROM }}
           UNIRATE_API_KEY: ${{ secrets.UNIRATE_API_KEY }}
         run: |
-          helm upgrade --install myapp ./7project/charts/myapp-chart \
+          helm upgrade --install myapp ./7project/src/charts/myapp-chart \
             -n prod --create-namespace \
-            -f 7project/charts/myapp-chart/values-prod.yaml \
+            -f 7project/src/charts/myapp-chart/values-prod.yaml \
             --set deployment="prod" \
             --set domain="$DOMAIN" \
             --set domain_scheme="$DOMAIN_SCHEME" \

.github/workflows/frontend-pages.yml

@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: 7project/frontend
+        working-directory: 7project/src/frontend
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -45,7 +45,7 @@ jobs:
         with:
           node-version: '20'
           cache: 'npm'
-          cache-dependency-path: 7project/frontend/package-lock.json
+          cache-dependency-path: 7project/src/frontend/package-lock.json
 
       - name: Install dependencies
         run: npm ci
@@ -61,7 +61,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: frontend-dist
-          path: 7project/frontend/dist
+          path: 7project/src/frontend/dist
 
   deploy:
     name: Deploy to Cloudflare Pages

.github/workflows/run-tests.yml

@@ -46,21 +46,21 @@ jobs:
 
       - name: Add test dependencies to requirements
         run: |
-          echo "pytest==8.4.2" >> ./7project/backend/requirements.txt
+          echo "pytest==8.4.2" >> ./7project/src/backend/requirements.txt
-          echo "pytest-asyncio==1.2.0" >> ./7project/backend/requirements.txt
+          echo "pytest-asyncio==1.2.0" >> ./7project/src/backend/requirements.txt
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r ./7project/backend/requirements.txt
+          pip install -r ./7project/src/backend/requirements.txt
 
       - name: Run Alembic migrations
         run: |
           alembic upgrade head
-        working-directory: ./7project/backend
+        working-directory: ./7project/src/backend
 
       - name: Run tests with pytest
         env:
           PYTEST_RUN_CONFIG: "True"
         run: pytest
-        working-directory: ./7project/backend
+        working-directory: ./7project/src/backend

.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

7project/.gitignore

@@ -1,8 +1,8 @@
-/tofu/controlplane.yaml
+/src/tofu/controlplane.yaml
-/tofu/kubeconfig
+/src/tofu/kubeconfig
-/tofu/talosconfig
+/src/tofu/talosconfig
-/tofu/terraform.tfstate
+/src/tofu/terraform.tfstate
-/tofu/terraform.tfstate.backup
+/src/tofu/terraform.tfstate.backup
-/tofu/worker.yaml
+/src/tofu/worker.yaml
-/tofu/.terraform.lock.hcl
+/src/tofu/.terraform.lock.hcl
-/tofu/.terraform/
+/src/tofu/.terraform/

7project/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

7project/frontend/src/config.ts

@@ -1,5 +0,0 @@
-export const BACKEND_URL: string =
-  import.meta.env.VITE_BACKEND_URL ?? '';
-
-export const VITE_UNIRATE_API_KEY: string =
-  import.meta.env.VITE_UNIRATE_API_KEY ?? 'wYXMiA0bz8AVRHtiS9hbKIr4VP3k5Qff8XnQdKQM45YM3IwFWP6y73r3KMkv1590';

7project/report.md

@@ -20,52 +20,61 @@ through multiple bank accounts. Users can label their transactions with custom c
 filtering and visualization. New transactions are automatically fetched in the background.
 
 ## Architecture Overview
+
 Our system is a full‑stack web application composed of a React frontend, a FastAPI backend,
-a PostgreSQL database, and asynchronous background workers powered by Celery with RabbitMQ. 
+a asynchronousMariaDB database with Maxscale, and background workers powered by Celery with RabbitMQ.
-Redis is available for caching/kv and may be used by Celery as a result backend. The backend 
+The backend exposes REST endpoints for authentication (email/password and OAuth), users, categories,
-exposes REST endpoints for authentication (email/password and OAuth), users, categories, 
+transactions, exchange rates and bank APIs. Infrastructure for Kubernetes is managed via Terraform/OpenTofu and
-transactions, exchange rates and bank APIs. A thin controller layer (FastAPI routers) lives under app/api. 
+the application is packaged via a Helm chart. This all is deployed on private TalosOS cluster running on Proxmox VE with
-Infrastructure for Kubernetes is provided via OpenTofu (Terraform‑compatible) modules and 
+CI/CD and with public access over Cloudflare tunnels. Static files for frontend are served via Cloudflare pages.
-the application is packaged via a Helm chart.
+Other services deployed in the cluster includes Longhorn for persistent storage, Prometheus with Grafana for monitoring.
 
 ### High-Level Architecture
 
 ```mermaid
-flowchart LR
+flowchart TB
-    proc_queue[Message Queue] --> proc_queue_worker[Worker Service]
+    n3(("User")) <--> client["Frontend"]
-    proc_queue_worker --> ext_mail[(Email Service)]
+    proc_queue["Message Queue"] --> proc_queue_worker["Worker Service"]
-    proc_cron[Cron] --> svc
+    proc_queue_worker -- SMTP --> ext_mail[("Email Service")]
-    proc_queue_worker --> ext_bank[(Bank API)]
+    proc_queue_worker <-- HTTP request/response --> ext_bank[("Bank API")]
-    proc_queue_worker --> db
+    proc_queue_worker <--> db[("Database")]
-    client[Client/Frontend] <--> svc[Backend API]
+    proc_cron["Cron"] <-- HTTP request/response --> svc["Backend API"]
     svc --> proc_queue
-    svc <--> db[(Database)]
+    n2["Cloudflare tunnel"] <-- HTTP request/response --> svc
-    svc <--> api[(UniRate API)]
+    svc <--> db
+    svc <-- HTTP request/response --> api[("UniRate API")]
+    client <-- HTTP request/response --> n2
 ```
 
 The workflow works in the following way:
+
 - Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
-the database via the backend API and currency rates from UniRate API.
+  the database via the backend API and currency rates from UniRate API.
-- When the client opts for fetching new transactions via the Bank API, the backend delegates the task 
+- When the client opts for fetching new transactions via the Bank API, cron will trigger periodic fetching
-to a background worker service via the Message queue.
+  using background worker.
 - After successful load, these transactions are stored to the database and displayed to the client
-- There is also a Task planner, that executes periodic tasks, like fetching new transactions automatically from the Bank APIs
 
 ### Features
+
 - The stored transactions are encrypted in the DB for security reasons.
 - For every pull request the full APP is deployed on a separate URL and the tests are run by github CI/CD
 - On every push to main, the production app is automatically updated
 - UI is responsive for mobile devices
+- Slow operations (emails, transactions fetching) are handled
+  in the background by Celery workers.
+- App is monitored using prometheus metrics endpoint and metrics are shown in Grafana dashboard.
 
 ### Components
 
-- Frontend (frontend/): React + TypeScript app built with Vite. Talks to the backend via REST, handles login/registration, shows latest transactions, filtering, and allows adding transactions.
+- Frontend (frontend/): React + TypeScript app built with Vite. Talks to the backend via REST, handles
-- Backend API (backend/app): FastAPI app with routers under app/api for auth, users, categories, transactions, exchange rates and bankAPI. Uses FastAPI Users for auth (JWT + OAuth), SQLAlchemy ORM, and Pydantic v2 schemas.
+  login/registration, shows latest transactions, filtering, and allows adding transactions.
-- Worker service (backend/app/workers): Celery worker handling asynchronous tasks (e.g., sending verification emails, future background processing).
+- Backend API (backend/app): FastAPI app with routers under app/api for auth, users, categories, transactions, exchange
-- Database (PostgreSQL): Persists users, categories, transactions; schema managed by Alembic migrations.
+  rates and bankAPI. Uses FastAPI Users for auth (JWT + OAuth), SQLAlchemy ORM, and Pydantic v2 schemas.
-- Message Queue (RabbitMQ): Transports background jobs from the API to the worker.
+- Worker service (backend/app/workers): Celery worker handling background tasks (emails, transactions fetching).
-- Cache/Result Store (Redis): Available for caching or Celery result backend.
+- Database (MariaDB with Maxscale): Persists users, categories, transactions; schema managed by Alembic migrations.
-- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Argo CD, cert-manager, Cloudflare tunnel, etc.).
+- Message Queue (RabbitMQ): Queues background tasks for Celery workers.
+- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Cloudflare tunnel,
+  etc.).
 - Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
 
 ### Technologies Used
@@ -75,227 +84,374 @@ to a background worker service via the Message queue.
 - Database: MariaDB with Maxscale
 - Background jobs: RabbitMQ, Celery
 - Containerization/Orchestration: Docker, Docker Compose (dev), Kubernetes, Helm
-- IaC/Platform: Proxmox, Talos, Cloudflare pages, OpenTofu (Terraform), cert-manager, MetalLB, Cloudflare Tunnel, Prometheus, Loki
+- IaC/Platform: Proxmox, Talos, Cloudflare pages, OpenTofu (Terraform), cert-manager, MetalLB, Cloudflare Tunnel,
+  Prometheus, Loki
 
 ## Prerequisites
 
 ### System Requirements
 
-- Operating System (dev): Linux, macOS, or Windows with Docker support
+#### Development
-- Operating System (prod): Linux with kubernetes
+
-- Minimum RAM: 4 GB (8 GB recommended for running backend, frontend, and database together)
+- Minimum RAM: 8 GB
-- Storage: 4 GB free (Docker images may require additional space)
+- Storage: 10 GB+ free
+
+#### Production
+
+- 1 + 4 nodes
+- CPU: 4 cores
+- RAM: 8 GB
+- Storage: 200 GB
 
 ### Required Software
 
-- Docker Desktop or Docker Engine
+#### Development
+
+- Docker
 - Docker Compose
 - Node.js and npm
-- Python 3.12+ 
+- Python 3.12
 - MariaDB 11
-- Helm 3.12+ and kubectl 1.29+
+
+#### Production
+
+##### Minimal:
+
+- domain name with Cloudflare`s nameservers - tunnel, pages
+- Kubernetes cluster
+- kubectl
+- Helm
 - OpenTofu
 
-### Environment Variables (common)
+##### Our setup specifics:
 
-# TODO: UPDATE
+- Proxmox VE
-- Backend: SECRET, FRONTEND_URL, BACKEND_URL, DATABASE_URL, RABBITMQ_URL, REDIS_URL, UNIRATE_API_KEY
+- TalosOS cluster
+- talosctl
+- GitHub self-hosted runner with access to the cluster
+- TailScale for remote access to cluster
 
-- OAuth vars (Backend): MOJEID_CLIENT_ID/SECRET, BANKID_CLIENT_ID/SECRET (optional)
+### Environment Variables
-- Frontend: VITE_BACKEND_URL
+
+#### Backend
+
+- `MOJEID_CLIENT_ID`, `MOJEID_CLIENT_SECRET` \- OAuth client ID and secret for
+  MojeID - https://www.mojeid.cz/en/provider/
+- `BANKID_CLIENT_ID`, `BANKID_CLIENT_SECRET` \- OAuth client ID and secret for BankID - https://developer.bankid.cz/
+- `CSAS_CLIENT_ID`, `CSAS_CLIENT_SECRET` \- OAuth client ID and secret for Česká
+  spořitelna - https://developers.erstegroup.com/docs/apis/bank.csas
+- `DATABASE_URL`(or `MARIADB_HOST`, `MARIADB_PORT`, `MARIADB_DB`, `MARIADB_USER`, `MARIADB_PASSWORD`) \- MariaDB
+  connection details
+- `RABBITMQ_USERNAME`, `RABBITMQ_PASSWORD` \- credentials for RabbitMQ
+- `SENTRY_DSN` \- Sentry DSN for error reporting
+- `DB_ENCRYPTION_KEY` \- symmetric key for encrypting sensitive data in the database
+- `SMTP_HOST`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD`, `SMTP_USE_TLS`, `SMTP_USE_SSL`, `SMTP_FROM` \- SMTP
+  configuration (host, port, auth credentials, TLS/SSL options, sender).
+- `UNIRATE_API_KEY` \- API key for UniRate.
+
+#### Frontend
+
+- `VITE_BACKEND_URL` \- URL of the backend API
 
 ### Dependencies (key libraries)
-Backend: FastAPI, fastapi-users, SQLAlchemy, pydantic v2, Alembic, Celery, uvicorn  
+
+Backend: FastAPI, fastapi-users, SQLAlchemy, pydantic v2, Alembic, Celery, uvicorn, pytest
 Frontend: React, TypeScript, Vite
 
 ## Local development
 
-You can run the project with Docker Compose and Python virtual environment for testing and dev purposes
+You can run the project with Docker Compose and Python virtual environment for testing and development purposes
 
 ### 1) Clone the Repository
 
 ```bash
 git clone https://github.com/dat515-2025/Group-8.git
-cd 7project
+cd Group-8/7project/src
 ```
 
 ### 2) Install dependencies
+
 Backend
+
 ```bash
+cd backend
 python3 -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
 ```
-Frontend
+
+### 3) Run Docker containers
+
 ```bash
-# In 7project/frontend
+cd ..
-npm install
+docker compose up -d
 ```
 
-### 3) Manual Local Run
+### 4) Prepare the database
 
-Backend
 ```bash
-# From the 7project/ directory
-docker compose up --build
-# This starts: MariaDB, RabbitMQ
-
-# Set environment variables (or create .env file)
-# TODO: fix
-export SECRET=CHANGE_ME_SECRET
-export FRONTEND_DOMAIN_SCHEME=http://localhost:5173
-export BANKID_CLIENT_ID=CHANGE_ME
-export BANKID_CLIENT_SECRET=CHANGE_ME
-export CSAS_CLIENT_ID=CHANGE_ME
-export CSAS_CLIENT_SECRET=CHANGE_ME
-export MOJEID_CLIENT_ID=CHANGE_ME
-export MOJEID_CLIENT_SECRET=CHANGE_ME
-# Apply DB migrations (Alembic)
-# From 7project
 bash upgrade_database.sh
+```
 
-# Run API
+### 5) Run backend
+
+```bash
+cd backend
+
+#TODO: set env variables
 uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
+```
 
+### 6) Run Celery worker (optional, in another terminal)
+
+```bash
+cd Group-8/7project/backend
+source .venv/bin/activate
 celery -A app.celery_app.celery_app worker -l info
 ```
 
-Frontend
+### 7) Install frontend dependencies and run
+
 ```bash
-# Configure backend URL for dev
+cd ../frontend
-echo 'VITE_BACKEND_URL=http://127.0.0.1:8000' > .env
+npm i
 npm run dev
-# Open http://localhost:5173
 ```
 
-- Backend default: http://127.0.0.1:8000 (OpenAPI at /docs)
+- Backend available at: http://127.0.0.1:8000 (OpenAPI at /docs)
-- Frontend default: http://localhost:5173
+- Frontend available at: http://localhost:5173
 
 ## Build Instructions
+
 ### Backend
+
 ```bash
-# run in project7/backend
+cd 7project/backend
-docker buildx build --platform linux/amd64,linux/arm64 -t your_container_registry/your_name --push .
+# Dont forget to set correct image tag with your registry and name
+# For example lukastrkan/cc-app-demo or gitea.ltrk.dev/lukas/cc-app-demo
+docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
 ```
+
 ### Frontend
+
 ```bash
-# run in project7/frontend
+cd project7/frontend
 npm ci
 npm run build
 ```
 
 ## Deployment Instructions
+
 ### Setup Cluster
-Deployment should work on any Kubernetes cluster. However, we are using 4 TalosOS virtual machines (1 control plane, 3 workers) 
+
+Deployment should work on any Kubernetes cluster. However, we are using 4 TalosOS virtual machines (1 control plane, 3
+workers)
 running on top of Proxmox VE.
 
-1) Create 4 VMs with TalosOS
+1) Create at least 4 VMs with TalosOS (4 cores, 8 GB RAM, 200 GB disk)
 2) Install talosctl for your OS: https://docs.siderolabs.com/talos/v1.10/getting-started/talosctl
 3) Generate Talos config
-```bash
+4) Navigate to tofu directory
-# TODO: add commands
-```
-4) Edit the generated worker.yaml
-- add google container registry mirror
-- add modules from config generator 
-- add extramounts for persistent storage
-- add kernel modules
 
-5) Apply the config to the VMs
 ```bash
-#TODO: add config apply commands
+cd 7project/tofu
+````
+
+5) Set IP addresses in environment variables
+
+```bash
+CONTROL_PLANE_IP=<control-plane-ip>
+WORKER1_IP=<worker1-ip>
+WORKER2_IP=<worker2-ip>
+WORKER3_IP=<worker3-ip>
+WORKER4_IP=<worker4-ip>
+....
 ```
 
-6) Verify the cluster is up
+6) Create config files
+
 ```bash
+# change my-cluster to your desired cluster name
+talosctl gen config my-cluster https://$CONTROL_PLANE_IP:6443
 ```
 
-7) Export kubeconfig
+7) Edit the generated configs
-```bash
+
-# TODO: add export command
+Apply the following changes to `worker.yaml`:
+
+1) Add mounts for persistent storage to `machine.kubelet.extraMounts` section:
+
+```yaml
+extraMounts:
+  - destination: /var/lib/longhorn
+    type: bindind.
+    source: /var/lib/longhorn
+    options:
+      - bind
+      - rshared
+      - rw
 ```
 
+2) Change `machine.install.image` to image with extra modules:
+
+```yaml
+image: factory.talos.dev/metal-installer/88d1f7a5c4f1d3aba7df787c448c1d3d008ed29cfb34af53fa0df4336a56040b:v1.11.1
+```
+
+or you can use latest image generated at https://factory.talos.dev with following options:
+
+- Bare-metal machine
+- your Talos os version
+- amd64 architecture
+- siderolabs/iscsi-tools
+- siderolabs/util-linux-tools
+- (Optionally) siderolabs/qemu-guest-agent
+
+Then copy "Initial Installation" value and paste it to the image field.
+
+3) Add docker registry mirror to `machine.registries.mirrors` section:
+
+```yaml
+registries:
+  mirrors:
+    docker.io:
+      endpoints:
+        - https://mirror.gcr.io
+        - https://registry-1.docker.io
+```
+
+8) Apply configs to the VMs
+
+```bash
+talosctl apply-config --insecure --nodes $CONTROL_PLANE_IP --file controlplane.yaml
+talosctl apply-config --insecure --nodes $WORKER1_IP --file worker.yaml
+talosctl apply-config --insecure --nodes $WORKER2_IP --file worker.yaml
+talosctl apply-config --insecure --nodes $WORKER3_IP --file worker.yaml
+talosctl apply-config --insecure --nodes $WORKER4_IP --file worker.yaml
+```
+
+9) Boostrap the cluster and retrieve kubeconfig
+
+```bash
+export TALOSCONFIG=$(pwd)/talosconfig
+talosctl config endpoint https://$CONTROL_PLANE_IP:6443
+talosctl config node $CONTROL_PLANE_IP
+
+talosctl bootstrap
+
+talosctl kubeconfig .
+```
+
+You can now use k8s client like https://headlamp.dev/ with the generated kubeconfig file.
+
+### Install base services to the cluster
+
+1) Copy and edit variables
 
-### Install
-1) Install base services to cluster
 ```bash
-cd tofu
-# copy and edit variables
 cp terraform.tfvars.example terraform.tfvars
-# authenticate to your cluster/cloud as needed, then:
+```
+
+- `metallb_ip_range` - set to range available in your network for load balancer services
+- `mariadb_password` - password for internal mariadb user
+- `mariadb_root_password` - password for root user
+- `mariadb_user_name` - username for admin user
+- `mariadb_user_host` - allowed hosts for admin user
+- `mariadb_user_password` - password for admin user
+- `metallb_maxscale_ip`, `metallb_service_ip`, `metallb_primary_ip`, `metallb_secondary_ip` - IPs for database
+  cluster,  
+  set them to static IPs from the `metallb_ip_range`
+- `s3_enabled`, `s3_bucket`, `s3_region`, `s3_endpoint`, `s3_key_id`, `s3_key_secret` - S3 compatible storage for
+  backups (optional)
+- `phpmyadmin_enabled` - set to false if you want to disable phpmyadmin
+- `rabbitmq-password` - password for RabbitMQ
+
+- `cloudflare_account_id` - your Cloudflare account ID
+- `cloudflare_api_token` - your Cloudflare API token with permissions to manage tunnels and DNS
+- `cloudflare_email` - your Cloudflare account email
+- `cloudflare_tunnel_name` - name for the tunnel
+- `cloudflare_domain` - your domain name managed in Cloudflare
+
+2) Deploy without Cloudflare module first
+
+```bash
 tofu init
 tofu apply -exclude modules.cloudflare
+```
+
+3) Deploy rest of the modules
+
+```bash
 tofu apply
 ```
 
-2) Deploy the app using Helm
+### Configure deployment
-```bash
-# Set the namespace
-kubectl create namespace myapp || true
 
-# Install/upgrade the chart with required values
+1) Create self-hosted runner with access to the cluster or make cluster publicly accessible
-helm upgrade --install myapp charts/myapp-chart \
+2) Change `jobs.deploy.runs-on` in `.github/workflows/deploy-prod.yml` and in `.github/workflows/deploy-pr.yaml` to your
-  -n myapp \
+   runner label
-  -f charts/myapp-chart/values.yaml \
+3) Add variables to GitHub in repository settings:
-  --set image.backend.repository=myorg/myapp-backend \
+    - `PROD_DOMAIN` - base domain for deployments (e.g. ltrk.cz)
-  --set image.backend.tag=latest \
+    - `DEV_FRONTEND_BASE_DOMAIN` - base domain for your cloudflare pages
-  --set env.BACKEND_URL="https://myapp.example.com" \
+4) Add secrets to GitHub in repository settings:
-  --set env.FRONTEND_URL="https://myapp.example.com" \
+    - CLOUDFLARE_ACCOUNT_ID - same as in tofu/terraform.tfvars
-  --set env.SECRET="CHANGE_ME_SECRET"
+    - CLOUDFLARE_API_TOKEN - same as in tofu/terraform.tfvars
-```
+    - DOCKER_USER - your docker registry username
-Adjust values to your registry and domain. The chart’s NOTES.txt includes additional examples.
+    - DOCKER_PASSWORD - your docker registry password
-
+    - KUBE_CONFIG - content of your kubeconfig file for the cluster
-3) Expose and access
+    - PROD_DB_PASSWORD - same as MARIADB_PASSWORD
-- If using Cloudflare Tunnel or an ingress, configure DNS accordingly (see tofu/modules/cloudflare and deployment/tunnel.yaml).
+    - PROD_RABBITMQ_PASSWORD - same as MARIADB_PASSWORD
-- For quick testing without ingress:
+    - PROD_DB_ENCRYPTION_KEY - same as DB_ENCRYPTION_KEY
-```bash
+    - MOJEID_CLIENT_ID
-kubectl -n myapp port-forward deploy/myapp-backend 8000:8000
+    - MOJEID_CLIENT_SECRET
-kubectl -n myapp port-forward deploy/myapp-frontend 5173:80
+    - BANKID_CLIENT_ID
-```
+    - BANKID_CLIENT_SECRET
-
+    - CSAS_CLIENT_ID
-### Verification
+    - CSAS_CLIENT_SECRET
-
+    - SENTRY_DSN
-```bash
+    - SMTP_HOST
-# Check pods
+    - SMTP_PORT
-kubectl -n myapp get pods
+    - SMTP_USERNAME
-
+    - SMTP_PASSWORD
-# Backend health
+    - SMTP_FROM
-curl -i http://127.0.0.1:8000/
+    - UNIRATE_API_KEY
-# OpenAPI
+5) On Github open Actions tab, select "Deploy Prod" and run workflow manually
-open http://127.0.0.1:8000/docs
-
-# Frontend (if port-forwarded)
-open http://localhost:5173
-```
 
 ## Testing Instructions
-The tests are located in 7project/backend/tests directory. All tests are run by GitHub actions on every pull request and push to main.
+
+The tests are located in 7project/backend/tests directory. All tests are run by GitHub actions on every pull request and
+push to main.
 See the workflow [here](../.github/workflows/run-tests.yml).
 
-If you want to run the tests locally, the preferred is to use a [bash script](backend/test-with-ephemeral-mariadb.sh)
+If you want to run the tests locally, the preferred way is to use a [bash script](src/backend/test_locally.sh)
-that will start a [test DB container](backend/docker-compose.test.yml) and remove it afterward.
+that will start a test DB container with [docker compose](src/backend/docker-compose.test.yml)  and remove it afterwards.
 ```bash
 cd 7project/backend 
-bash test-with-ephemeral-mariadb.sh
+bash test_locally.sh
 ```
 
-
 ### Unit Tests
-There are only 5 basic unit tests, since our services logic is very simple
+
+There are 5 basic unit tests, since our services logic is very simple
+
 ```bash
-bash test-with-ephemeral-mariadb.sh --only-unit
+bash test_locally.sh --only-unit
 ```
 
 ### Integration Tests
+
 There are 9 basic unit tests, testing the individual backend API logic
+
 ```bash
-bash test-with-ephemeral-mariadb.sh --only-integration
+bash test_locally.sh --only-integration
 ```
 
 ### End-to-End Tests
+
 There are 7 e2e tests, testing more complex app logic
+
 ```bash
-bash test-with-ephemeral-mariadb.sh --only-e2e
+bash test_locally.sh --only-e2e
 ```
 
 ## Usage Examples
@@ -378,18 +534,18 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 > This information is used for individual grading.
 > Link to the specific commit on GitHub for each contribution.
 
-| Task/Component                                                        | Assigned To | Status        | Time Spent | Difficulty | Notes       |
+| Task/Component                                                                                                    | Assigned To | Status         | Time Spent | Difficulty | Notes                                                                                               |
-|-----------------------------------------------------------------------|-------------| ------------- |------------|------------| ----------- |
+|-------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------|------------|-----------------------------------------------------------------------------------------------------|
-| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#) | Lukas       | ✅ Complete    | [X hours]  | Medium     | [Any notes] |
+| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#)                                             | Lukas       | ✅ Complete     | [X hours]  | Medium     | [Any notes]                                                                                         |
-| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md)          | Both        | ✅ Complete    | 4 Hours    | Easy       | [Any notes] |
+| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md)                             | Both        | ✅ Complete     | 4 Hours    | Easy       | [Any notes]                                                                                         |
-| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api)  | Dejan       | ✅ Complete    | 12 hours   | Medium     | [Any notes] |
+| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api)              | Dejan       | ✅ Complete     | 12 hours   | Medium     | [Any notes]                                                                                         |
-| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models)  | Lukas       | 🔄 In Progress    | [X hours]  | Medium     | [Any notes] |
+| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models)           | Lukas       | ✅ Complete     | [X hours]  | Medium     | [Any notes]                                                                                         |
-| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend)     | Dejan       | ✅ Complete | 17 hours   | Medium     | [Any notes] |
+| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend)                        | Dejan       | ✅ Complete     | 17 hours   | Medium     | [Any notes]                                                                                         |
-| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml)     | Lukas       | ✅ Complete    | [X hours]  | Easy       | [Any notes] |
+| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml)                     | Lukas       | ✅ Complete     | 3 hours    | Easy       | [Any notes]                                                                                         |
-| [Cloud Deployment](https://github.com/dat515-2025/Group-8/blob/main/7project/deployment/app-demo-deployment.yaml)         | Lukas       | ✅ Complete    | [X hours]  | Hard       | [Any notes] |
+| [Cloud Deployment](https://github.com/dat515-2025/Group-8/blob/main/7project/deployment/app-demo-deployment.yaml) | Lukas       | ✅ Complete     | [X hours]  | Hard       | Using Talos cluster running in proxmox - easy snapshots etc. Frontend deployed at Cloudflare pages. |
-| [Testing Implementation](https://github.com/dat515-2025/group-name)   | Dejan       | ✅ Complete    | 16 hours   | Medium     | [Any notes] |
+| [Testing Implementation](https://github.com/dat515-2025/group-name)                                               | Dejan       | ✅ Complete     | 16 hours   | Medium     | [Any notes]                                                                                         |
-| [Documentation](https://github.com/dat515-2025/group-name)            | Both        | 🔄 In Progress   | [X hours]  | Easy       | [Any notes] |
+| [Documentation](https://github.com/dat515-2025/group-name)                                                        | Both        | 🔄 In Progress | [X hours]  | Easy       | [Any notes]                                                                                         |
-| [Presentation Video](https://github.com/dat515-2025/group-name)       | Both        | ❌ Not Started     | [X hours]  | Medium     | [Any notes] |
+| [Presentation Video](https://github.com/dat515-2025/group-name)                                                   | Both        | ❌ Not Started  | [X hours]  | Medium     | [Any notes]                                                                                         |
 
 **Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
 
@@ -399,30 +555,46 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 
 ### [Lukáš]
 
-| Date           | Activity            | Hours      | Description                                        |
+## Hour Sheet
-|----------------|---------------------|------------|----------------------------------------------------|
+
-| 4.10 to 10.10  | Initial Setup       | 40         | Repository setup, project structure, cluster setup |
+**Name:** Lukáš Trkan
-| 14.10 to 16.10 | Backend Development | 12         | Implemented user authentication - oauth            |
+
-| 8.10 to 12.10  | CI/CD               | 10         | Created database schema and models                 |
+| Date            | Activity                    | Hours   | Description                                                                         | Representative Commit / PR                            |
-| [Date]         | Testing             | [X.X]      | Unit tests for API endpoints                       |
+|:----------------|:----------------------------|:--------|:------------------------------------------------------------------------------------|:------------------------------------------------------|
-| [Date]         | Documentation       | [X.X]      | Updated README and design doc                      |
+| 18.9. - 19.9.   | Initial Setup & Design      | 40      | Repository init, system design diagrams, basic Terraform setup                      | `feat(infrastructure): add basic terraform resources` |
-| **Total**      |                     | **[XX.X]** |                                                    |
+| 20.9. - 5.10.   | Core Infrastructure & CI/CD | 12      | K8s setup (ArgoCD), CI/CD workflows, RabbitMQ, Redis, Celery workers, DB migrations | `PR #2`, `feat(infrastructure): add rabbitmq cluster` |
+| 6.10. - 9.10.   | Frontend Infra & DB         | 5       | Deployed frontend to Cloudflare, setup metrics, created database models             | `PR #16` (Cloudflare), `PR #19` (DB structure)        |
+| 10.10. - 11.10. | Backend                     | 5       | Implemented OAuth support (MojeID, BankID)                                          | `feat(auth): add support for OAuth and MojeID`        |
+| 12.10.          | Infrastructure              | 2       | Added database backups                                                              | `feat(infrastructure): add backups`                   |
+| 16.10.          | Infrastructure              | 4       | Implemented secrets management, fixed deployment/env variables                      | `PR #29` (Deployment envs)                            |
+| 17.10.          | Monitoring                  | 1       | Added Sentry logging                                                                | `feat(app): add sentry loging`                        |
+| 21.10. - 22.10. | Backend                     | 8       | Added ČSAS bank connection                                                          | `PR #32` (Fix React OAuth)                            |
+| 29.10. - 30.10. | Backend                     | 5       | Implemented transaction encryption, add bank scraping                               | `PR #39` (CSAS Scraping)                              |
+| 30.10.          | Monitoring                  | 6       | Implemented Loki logging and basic Prometheus metrics                               | `PR #42` (Prometheus metrics)                         |
+| 9.11.           | Monitoring                  | 2       | Added custom Prometheus metrics                                                     | `PR #46` (Prometheus custom metrics)                  |
+| 11.11.          | Tests                       | 1       | Investigated and fixed broken Pytest environment                                    | `fix(tests): set pytest env`                          |
+| 11.11. - 12.11. | Features & Deployment       | 6       | Added cron support, email sender service, updated workers & image                   | `PR #49` (Email), `PR #50` (Update workers)           |
+| 18.9 - 14.11    | Documentation               | 8       | Updated report.md, design docs, and tfvars.example                                  | `Create design.md`, `update report`                   |
+| **Total**       |                             | **105** |                                                                                     |                                                       |
 
 ### Dejan
 
-| Date            | Activity             | Hours  | Description                                                   |
+| Date            | Activity                 | Hours  | Description                                                   | Representative Commit / PR                               |
-|-----------------|----------------------|--------|---------------------------------------------------------------|
+|:----------------|:-------------------------|:-------|:--------------------------------------------------------------|:---------------------------------------------------------|
-| 25.9.           | Design               | 2      | 6design                                                       |
+| 25.9.           | Design                   | 2      | 6design                                                       |                                                          |
-| 9.10 to 11.10.  | Backend APIs         | 12     | Implemented Backend APIs                                      |
+| 9.10 to 11.10.  | Backend APIs             | 14     | Implemented Backend APIs                                      | `PR #26`, `20-create-a-controller-layer-on-backend-side` |
-| 13.10 to 15.10. | Frontend Development | 8      | Created user interface mockups                                |
+| 13.10 to 15.10. | Frontend Development     | 8      | Created user interface mockups                                | `PR #28`, `frontend basics`                              |
-| Continually     | Documentation        | 6      | Documenting the dev process                                   |
+| Continually     | Documentation            | 8      | Documenting the dev process                                   |                                                          |
-| 21.10 to 23.10  | Tests, frontend      | 10     | Test basics, balance charts, and frontend improvement         |
+| 21.10 to 23.10  | Tests, frontend          | 10     | Test basics, balance charts, and frontend improvement         | `PR #31`, `30 create tests and set up a GitHub pipeline` |
-| 28.10 to 30.10  | CI                   | 6      | Integrated tests with test database setup on github workflows |
+| 28.10 to 30.10  | CI                       | 6      | Integrated tests with test database setup on github workflows | `PR #28`, `frontend basics`                              |
-| 28.10 to 30.10  | Frontend             | 7      | UI improvements and exchange rate API integration             |
+| 28.10 to 30.10  | Frontend                 | 8      | UI improvements and exchange rate API integration             | `PR #28`, `frontend basics`                              |
-| 4.11 to 6.11    | Tests                | 6      | Test fixes improvement, more integration and e2e              |
+| 4.11 to 6.11    | Tests                    | 6      | Test fixes improvement, more integration and e2e              | `PR #28`, `frontend basics`                              |
-| 4.11 to 6.11    | Frontend             | 6      | Fixes, Improved UI, added support for mobile devices          |
+| 4.11 to 6.11    | Frontend                 | 6      | Fixes, Improved UI, added support for mobile devices          | `PR #28`, `frontend basics`                              |
-| **Total**       |                      | **63** |                                                               |
+| 11.11           | Backend APIs             | 4      | Moved rates API, mock bank to Backend, few fixes              | `PR #28`, `frontend basics`                              |
-
+| 11.11 to 12.11  | Tests                    | 3      | Local testing DB container, few fixes                         | `PR #28`, `frontend basics`                              |
+| 12.11           | Frontend                 | 3      | Enabled multiple transaction edits at once, CSAS button state | `PR #28`, `frontend basics`                              |
+| 13.11           | Video                    | 3      | Video                                                         |                                                          |
+| **Total**       |                          | **81** |                                                               |                                                          |
 
 ### Group Total: [XXX.X] hours
 
@@ -436,19 +608,46 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 
 ### Challenges Faced
 
-[Describe the main challenges and how you overcame them]
+#### Slow cluster performance
+
+This was caused by single SATA SSD disk running all VMs. This was solved by adding second NVMe disk just for Talos VMs.
+
+#### Stucked IaC deployment
+
+If the deployed module (helm chart for example) was not configured properly, it would get stuck and timeout resulting in
+namespace that cannot be deleted.
+This was solved by using snapshots in Proxmox and restoring if this happened.
 
 ### If We Did This Again
 
+#### Different framework
+
+FastAPI lacks usable build in support for database migrations and implementing Alembic was a bit tricky.
+Tricky was also integrating FastAPI auth system with React frontend, since there is no official project template.
+Using .NET (which we considered initially) would probably solve these issues.
+
 [What would you do differently? What worked well that you'd keep?]
 
 ### Individual Growth
 
-#### [Team Member 1 Name]
+#### [Lukas]
+
+This course finally forced me to learn kubernetes (been on by TODO list for at least 3 years).
+I had some prior experience with terraform/opentofu from work but this improved by understanding of it.
+
+The biggest challenge for me was time tracking since I am used to tracking to projects, not to tasks.
+(I am bad even at that :) ).
+
+It was also interesting experience to be the one responsible for the initial project structure/design/setup
+used not only by myself.
 
 [Personal reflection on growth, challenges, and learning]
 
-#### [Team Member 2 Name]
+#### [Dejan]
+Since I do not have a job, this project was probably the most complex one I have ever worked on. 
+It was also the first school project where I was encouraged to use AI.
+
+Lukas 
 
 [Personal reflection on growth, challenges, and learning]
 
@@ -456,4 +655,4 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
 ---
 
 **Report Completion Date**: [Date]
-**Last Updated**: 15.10.2025
+**Last Updated**: 13.11.2025

7project/src/backend/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

7project/src/backend/app/schemas/user.py

@@ -1,10 +1,11 @@
 import uuid
-from typing import Optional
+from typing import Optional, Dict, Any
 from fastapi_users import schemas
 
 class UserRead(schemas.BaseUser[uuid.UUID]):
     first_name: Optional[str] = None
     last_name: Optional[str] = None
+    config: Optional[Dict[str, Any]] = None
 
 class UserCreate(schemas.BaseUserCreate):
     first_name: Optional[str] = None

7project/src/backend/test_locally.sh

@@ -4,13 +4,13 @@ set -euo pipefail
 # Run tests against a disposable local MariaDB on host port 3307 using Docker Compose.
 # Requirements: Docker, docker compose plugin, Python, Alembic, pytest.
 # Usage:
-#   chmod +x ./test-with-ephemeral-mariadb.sh
+#   chmod +x ./test_locally.sh
 #   # From 7project/backend directory
-#   ./test-with-ephemeral-mariadb.sh [--only-unit|--only-integration|--only-e2e] [pytest-args...]
+#   ./test_locally.sh [--only-unit|--only-integration|--only-e2e] [pytest-args...]
 #   # Examples:
-#   ./test-with-ephemeral-mariadb.sh --only-unit -q
+#   ./test_locally.sh --only-unit -q
-#   ./test-with-ephemeral-mariadb.sh --only-integration -k "login"
+#   ./test_locally.sh --only-integration -k "login"
-#   ./test-with-ephemeral-mariadb.sh --only-e2e -vv
+#   ./test_locally.sh --only-e2e -vv
 #
 # This script will:
 # 1) Start a MariaDB 11.4 container (ephemeral storage, port 3307)