mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
42 Commits
59d53967b0
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
16f660ea5b | ||
| 7a0d7dc4af | |||
| fabdff3bef | |||
| 1c1130b9b0 | |||
| 7d7698450d | |||
|
|
db9092b78f | ||
| 3557b3ea13 | |||
| 4a1a9f03a1 | |||
| b1be15f559 | |||
|
|
515106b238 | ||
|
|
b5290119e9 | ||
| 0beb889f5e | |||
|
|
0a96c32c93 | ||
|
|
f1034f6ed5 | ||
| 0f729d28d1 | |||
| c689caea88 | |||
| 8c20deb690 | |||
| 39979b51ee | |||
| da0c77101d | |||
| a5a83e5d07 | |||
| 3749aa4525 | |||
| 94aa64addc | |||
| ba1677b2d3 | |||
|
|
8ea1ef9eea | ||
|
|
4b614902b2 | ||
| a152ecbe4d | |||
| 7d7dd98d0f | |||
| 5aca071ac2 | |||
|
|
80991c7390 | ||
|
|
1403e0029b | ||
| aa63e51e6a | |||
|
|
4aaaba3956 | ||
|
|
f0c28ba9e1 | ||
|
|
b560c07d62 | ||
|
|
f0b1452e30 | ||
| 6effb2793a | |||
|
|
ba7798259c | ||
| deb67f421e | |||
| 74557eeea8 | |||
| 2e0619d03f | |||
| 31add42d6d | |||
| 4de79169a2 |
4
.github/workflows/build-image.yaml
vendored
4
.github/workflows/build-image.yaml
vendored
@@ -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)"
|
||||
@@ -94,7 +94,7 @@ jobs:
|
||||
tags: |
|
||||
${{ env.IMAGE_REPO }}:${{ env.TAG1 }}
|
||||
${{ env.IMAGE_REPO }}:${{ env.TAG2 }}
|
||||
platforms: linux/amd64
|
||||
platforms: linux/arm64,linux/amd64
|
||||
|
||||
- name: Set outputs
|
||||
id: set
|
||||
|
||||
6
.github/workflows/deploy-pr.yaml
vendored
6
.github/workflows/deploy-pr.yaml
vendored
@@ -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
|
||||
|
||||
@@ -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" \
|
||||
|
||||
12
.github/workflows/deploy-prod.yaml
vendored
12
.github/workflows/deploy-prod.yaml
vendored
@@ -4,9 +4,9 @@ on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
paths:
|
||||
- 7project/backend/**
|
||||
- 7project/frontend/**
|
||||
- 7project/charts/myapp-chart/**
|
||||
- ../../7project/src/backend/**
|
||||
- ../../7project/src/frontend/**
|
||||
- ../../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" \
|
||||
|
||||
6
.github/workflows/frontend-pages.yml
vendored
6
.github/workflows/frontend-pages.yml
vendored
@@ -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
|
||||
|
||||
10
.github/workflows/run-tests.yml
vendored
10
.github/workflows/run-tests.yml
vendored
@@ -46,21 +46,21 @@ jobs:
|
||||
|
||||
- name: Add test dependencies to requirements
|
||||
run: |
|
||||
echo "pytest==8.4.2" >> ./7project/backend/requirements.txt
|
||||
echo "pytest-asyncio==1.2.0" >> ./7project/backend/requirements.txt
|
||||
echo "pytest==8.4.2" >> ./7project/src/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
|
||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
@@ -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
|
||||
16
7project/.gitignore
vendored
16
7project/.gitignore
vendored
@@ -1,8 +1,8 @@
|
||||
/tofu/controlplane.yaml
|
||||
/tofu/kubeconfig
|
||||
/tofu/talosconfig
|
||||
/tofu/terraform.tfstate
|
||||
/tofu/terraform.tfstate.backup
|
||||
/tofu/worker.yaml
|
||||
/tofu/.terraform.lock.hcl
|
||||
/tofu/.terraform/
|
||||
/src/tofu/controlplane.yaml
|
||||
/src/tofu/kubeconfig
|
||||
/src/tofu/talosconfig
|
||||
/src/tofu/terraform.tfstate
|
||||
/src/tofu/terraform.tfstate.backup
|
||||
/src/tofu/worker.yaml
|
||||
/src/tofu/.terraform.lock.hcl
|
||||
/src/tofu/.terraform/
|
||||
|
||||
8
7project/.idea/.gitignore
generated
vendored
Normal file
8
7project/.idea/.gitignore
generated
vendored
Normal file
@@ -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
|
||||
@@ -1,43 +1,6 @@
|
||||
# Lab 6: Design Document for Course Project
|
||||
|
||||
| Lab 6: | Design Document for Course Project |
|
||||
| ----------- | ---------------------------------- |
|
||||
| Subject: | DAT515 Cloud Computing |
|
||||
| Deadline: | **September 19, 2025 23:59** |
|
||||
| Grading: | No Grade |
|
||||
| Submission: | Group |
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [1. Design Document (design.md)](#1-design-document-designmd)
|
||||
|
||||
The design document is the first deliverable for your project.
|
||||
We separated this out as a separate deliverable, with its own deadline, to ensure that you have a clear plan before you start coding.
|
||||
This part only needs a cursory review by the teaching staff to ensure it is sufficiently comprehensive, while still realistic.
|
||||
The teaching staff will assign you to a project mentor who will provide guidance and support throughout the development process.
|
||||
|
||||
## 1. Design Document (design.md)
|
||||
|
||||
You are required to prepare a design document for your application.
|
||||
The design doc should be brief, well-organized and easy to understand.
|
||||
The design doc should be prepared in markdown format and named `design.md` and submitted in the project group's repository.
|
||||
Remember that you can use [mermaid diagrams](https://github.com/mermaid-js/mermaid#readme) in markdown files.
|
||||
|
||||
The design doc **should include** the following sections:
|
||||
|
||||
- **Overview**: A brief description of the application and its purpose.
|
||||
- **Architecture**: The high-level architecture of the application, including components, interactions, and data flow.
|
||||
- **Technologies**: The cloud computing technologies or services used in the application.
|
||||
- **Deployment**: The deployment strategy for the application, including any infrastructure requirements.
|
||||
|
||||
The design document should be updated throughout the development process and reflect the final implementation of your project.
|
||||
|
||||
Optional sections may include:
|
||||
|
||||
- Security: The security measures implemented in the application to protect data and resources.
|
||||
- Scalability: The scalability considerations for the application, including load balancing and auto-scaling.
|
||||
- Monitoring: The monitoring and logging strategy for the application to track performance and detect issues.
|
||||
- Disaster Recovery: The disaster recovery plan for the application to ensure business continuity in case of failures.
|
||||
- Cost Analysis: The cost analysis of running the application on the cloud, including pricing models and cost-saving strategies.
|
||||
- References: Any external sources or references used in the design document.
|
||||
# Personal Finance Tracker
|
||||
## Folder Structure
|
||||
- meetings: Contains note from meetings
|
||||
- scr: Source code for the project
|
||||
- checklist: Project checklist and self assessment tracking
|
||||
- report.md: Detailed report of the project
|
||||
@@ -1,8 +0,0 @@
|
||||
FROM python:3.11-trixie
|
||||
|
||||
WORKDIR /app
|
||||
COPY requirements.txt .
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
COPY . .
|
||||
EXPOSE 8000
|
||||
CMD alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 8000
|
||||
@@ -1,6 +0,0 @@
|
||||
import app.celery_app # noqa: F401
|
||||
from app.workers.celery_tasks import send_email
|
||||
|
||||
|
||||
def enqueue_email(to: str, subject: str, body: str) -> None:
|
||||
send_email.delay(to, subject, body)
|
||||
@@ -1,4 +0,0 @@
|
||||
import uvicorn
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("app.app:app", host="0.0.0.0", log_level="info")
|
||||
@@ -7,64 +7,65 @@ Focus on areas that align with your project goals and interests.
|
||||
The core deliverables are required.
|
||||
This means that you must get at least 2 points for each item in this category.
|
||||
|
||||
| **Category** | **Item** | **Max Points** | **Points** |
|
||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|
|
||||
| **Core Deliverables (Required)** | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 |
|
||||
| | Clean, readable code | 5 | 4 |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 |
|
||||
| | Proper version control usage | 5 | 5 |
|
||||
| 23 | Complete source code | 5 | 5 |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 |
|
||||
| | Updated design document | 5 | 2 |
|
||||
| | Clear build/deployment instructions | 5 | 2 |
|
||||
| | Troubleshooting guide | 5 | 1 |
|
||||
| | Completed self-assessment table | 5 | 2 |
|
||||
| 14 | Hour sheets for all members | 5 | 3 |
|
||||
| Presentation Video | Project demonstration | 5 | 0 |
|
||||
| | Code walk-through | 5 | 0 |
|
||||
| 0 | Deployment showcase | 5 | 0 |
|
||||
| **Technical Implementation** | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 8 |
|
||||
| | Advanced features implemented | 10 | 0 |
|
||||
| | Error handling & robustness | 10 | 4 |
|
||||
| 16 | User-friendly interface | 5 | 4 |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 |
|
||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN |
|
||||
| | Database integration | 10 | 10 |
|
||||
| | API design | 5 | 5 |
|
||||
| 20 | Microservices architecture | 10 | 0 |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 |
|
||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN |
|
||||
| | Serverless components | 10 | 0 |
|
||||
| 10 | Advanced cloud services | 5 | 0 |
|
||||
| **DevOps & Deployment** | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 |
|
||||
| | Optimized Dockerfile | 5 | 0 |
|
||||
| | Docker Compose | 5 | 5 - dev only |
|
||||
| 15 | Persistent storage | 5 | 5 |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 |
|
||||
| | Automated deployment | 5 | 5 |
|
||||
| | Multiple replicas | 5 | 5 |
|
||||
| 20 | Kubernetes deployment | 10 | 10 |
|
||||
| **Quality Assurance** | | | |
|
||||
| Testing | Unit tests | 5 | 2 |
|
||||
| | Integration tests | 5 | 2 |
|
||||
| | End-to-end tests | 5 | 5 |
|
||||
| 9 | Performance testing | 5 | 0 |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 |
|
||||
| | Logging | 5 | 2 - only to terminal add logstash |
|
||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint |
|
||||
| Security | HTTPS/TLS | 5 | 5 |
|
||||
| | Authentication | 5 | 5 |
|
||||
| 15 | Authorization | 5 | 5 |
|
||||
| **Innovation & Excellence** | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 |
|
||||
| Technical Excellence | Real-time features | 10 | 0 |
|
||||
| | Creative problem solving | 10 | ? |
|
||||
| | Performance optimization | 5 | 2 |
|
||||
| 2 | Exceptional user experience | 5 | 0 |
|
||||
| **Total** | | **255** | **153** |
|
||||
| **Category** | **Item** | **Max Points** | **Points** | **Comment** |
|
||||
|:---------------------------------|:----------------------------------------|:---------------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **Core Deliverables (Required)** | | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 | Project is well-organized, each part is separated (backend, frontend, IaC) and these parts are separated even mode (modules, packages...) |
|
||||
| | Clean, readable code | 5 | 4 | Should be readable(function names should help), but readability can always be improved |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | We used Github issues |
|
||||
| | Proper version control usage | 5 | 5 | We used branches for development, pull request reviews |
|
||||
| 23 | Complete source code | 5 | 5 | The code is complete - entire codebase is in this repository |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 10 | Our report is precise, anybody should be able to reproduce our deployment by following provided instructions |
|
||||
| | Updated design document | 5 | 4 | Our design document was updated and merged into the report |
|
||||
| | Clear build/deployment instructions | 5 | 5 | Should be clear |
|
||||
| | Troubleshooting guide | 5 | 3 | When it comes to troubleshooting, there is never enough documentation |
|
||||
| | Completed self-assessment table | 5 | 5 | Completed. |
|
||||
| 32 | Hour sheets for all members | 5 | 5 | Filled. |
|
||||
| Presentation Video | Project demonstration | 5 | 5 | Yes |
|
||||
| | Code walk-through | 5 | 3 | There was not enough time to go through all of our code, so we just mentioned some parts of it. |
|
||||
| 13 | Deployment showcase | 5 | 5 | Yes |
|
||||
| **Technical Implementation** | | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 10 | The app works as intended |
|
||||
| | Advanced features implemented | 10 | 5 | OAuth, BankAPI connection (not only mock bank) |
|
||||
| | Error handling & robustness | 10 | 5 | App notifies user about errors, errors in code are also logged by sentry and we get notified |
|
||||
| 24 | User-friendly interface | 5 | 4 | Responsive interface with dark mode support, should by user friendly enough |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 | Yes, the web server is stateless - authentication uses JWT, not sessions. |
|
||||
| | Stateful application | 10 | 10 | Yes, the app is stateful - data are persistently stored in database |
|
||||
| | Database integration | 10 | 10 | We have deployed 3 MariaDB nodes with replication, MaxScale proxy and periodic backups. Connection app with this setup is same as with standalone db. |
|
||||
| | API design | 5 | 5 | Backend APIs are implemented with public Swagger docs |
|
||||
| 33 | Microservices architecture | 10 | 3 | We have separated API deployment and worker deployment. Worker process slow tasks - emails, payment scraping. There is no need for another service in current state but adding it is easy. |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 | Yes (In private cluster), using GH Actions and self-hosted runner. |
|
||||
| | Cloud APIs usage | 10 | 8 | GH Actions deploys frontend to Cloudflare Pages, deployment creates CF tunnel record automatically |
|
||||
| | Serverless components | 10 | 10 | We are using CF pages for frontend deployment |
|
||||
| 33 | Advanced cloud services | 5 | 5 | Using CF provides us with DDOS protection, access rules, it hides our IP |
|
||||
| **DevOps & Deployment** | | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 | Yes |
|
||||
| | Optimized Dockerfile | 5 | 5 | Rootless Dockerfile |
|
||||
| | Docker Compose | 5 | 5 | For development environment |
|
||||
| 20 | Persistent storage | 5 | 5 | Yes, using Longhorn. |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 | Yes, possible by using Helm manually |
|
||||
| | Automated deployment | 5 | 5 | Yes, with Github actions |
|
||||
| | Multiple replicas | 5 | 5 | Yes, 3 pods with API, 3 pods with workers, 3 database pods |
|
||||
| 25 | Kubernetes deployment | 10 | 10 | Yes |
|
||||
| **Quality Assurance** | | | | |
|
||||
| Testing | Unit tests | 5 | 4 | All workflows are covered by tests |
|
||||
| | Integration tests | 5 | 5 | Yes |
|
||||
| | End-to-end tests | 5 | 5 | Yes |
|
||||
| 14 | Performance testing | 5 | 0 | No |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 | Yes |
|
||||
| | Logging | 5 | 4 | Logs can be accessed easily using Grafana |
|
||||
| | Metrics/Monitoring | 2 | 2 | Yes, visualised in Grafana |
|
||||
| 14 | Custom Metrics for your project | 3 | 3 | Yes, API has /metrics endpoint providing information about FastAPI itself and custom information such as number of users or transactions. |
|
||||
| Security | HTTPS/TLS | 5 | 5 | Yes |
|
||||
| | Authentication | 5 | 5 | Yes |
|
||||
| 15 | Authorization | 5 | 5 | Yes |
|
||||
| **Innovation & Excellence** | | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 | No |
|
||||
| Technical Excellence | Real-time features | 10 | 0 | No |
|
||||
| | Creative problem solving | 10 | 4 | Cron jobs for bank scraping |
|
||||
| | Performance optimization | 5 | 4 | Delegating emails and scraping to workers, hosting frontend on CF |
|
||||
| 11 | Exceptional user experience | 5 | 3 | |
|
||||
| **Total** | | **255** | **257** | |
|
||||
|
||||
## Grading Scale
|
||||
|
||||
@@ -72,7 +73,7 @@ This means that you must get at least 2 points for each item in this category.
|
||||
- **Maximum: 200+ points**
|
||||
|
||||
| Grade | Points |
|
||||
| ----- | -------- |
|
||||
|-------|----------|
|
||||
| A | 180-200+ |
|
||||
| B | 160-179 |
|
||||
| C | 140-159 |
|
||||
|
||||
@@ -1,73 +0,0 @@
|
||||
# React + TypeScript + Vite
|
||||
|
||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
||||
|
||||
Currently, two official plugins are available:
|
||||
|
||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
|
||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
||||
|
||||
## React Compiler
|
||||
|
||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
|
||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
||||
|
||||
```js
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
files: ['**/*.{ts,tsx}'],
|
||||
extends: [
|
||||
// Other configs...
|
||||
|
||||
// Remove tseslint.configs.recommended and replace with this
|
||||
tseslint.configs.recommendedTypeChecked,
|
||||
// Alternatively, use this for stricter rules
|
||||
tseslint.configs.strictTypeChecked,
|
||||
// Optionally, add this for stylistic rules
|
||||
tseslint.configs.stylisticTypeChecked,
|
||||
|
||||
// Other configs...
|
||||
],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
// other options...
|
||||
},
|
||||
},
|
||||
])
|
||||
```
|
||||
|
||||
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
|
||||
|
||||
```js
|
||||
// eslint.config.js
|
||||
import reactX from 'eslint-plugin-react-x'
|
||||
import reactDom from 'eslint-plugin-react-dom'
|
||||
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
files: ['**/*.{ts,tsx}'],
|
||||
extends: [
|
||||
// Other configs...
|
||||
// Enable lint rules for React
|
||||
reactX.configs['recommended-typescript'],
|
||||
// Enable lint rules for React DOM
|
||||
reactDom.configs.recommended,
|
||||
],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
// other options...
|
||||
},
|
||||
},
|
||||
])
|
||||
```
|
||||
@@ -9,6 +9,8 @@
|
||||
|
||||
**Project Name**: Personal Finance Tracker
|
||||
|
||||
**Deployment URL**: https://finance.ltrk.cz/
|
||||
|
||||
**Group Members**:
|
||||
|
||||
- 289229, Lukáš Trkan, lukastrkan
|
||||
@@ -22,17 +24,17 @@ filtering and visualization. New transactions are automatically fetched in the b
|
||||
## Architecture Overview
|
||||
|
||||
Our system is a full‑stack web application composed of a React frontend, a FastAPI backend,
|
||||
a MariaDB database with Maxscale, and asynchronous 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
|
||||
exposes REST endpoints for authentication (email/password and OAuth), users, categories,
|
||||
transactions, exchange rates and bank APIs. A thin controller layer (FastAPI routers) lives under app/api.
|
||||
Infrastructure for Kubernetes is provided via OpenTofu (Terraform‑compatible) modules and
|
||||
the application is packaged via a Helm chart.
|
||||
a asynchronousMariaDB database with Maxscale, and background workers powered by Celery with RabbitMQ.
|
||||
The backend 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
|
||||
the application is packaged via a Helm chart. This all is deployed on private TalosOS cluster running on Proxmox VE with
|
||||
CI/CD and with public access over Cloudflare tunnels. Static files for frontend are served via Cloudflare pages.
|
||||
Other services deployed in the cluster includes Longhorn for persistent storage, Prometheus with Grafana for monitoring.
|
||||
|
||||
### High-Level Architecture
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
flowchart TB
|
||||
n3(("User")) <--> client["Frontend"]
|
||||
proc_queue["Message Queue"] --> proc_queue_worker["Worker Service"]
|
||||
proc_queue_worker -- SMTP --> ext_mail[("Email Service")]
|
||||
@@ -50,11 +52,63 @@ 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.
|
||||
- When the client opts for fetching new transactions via the Bank API, the backend delegates the task
|
||||
to a background worker service via the Message queue.
|
||||
- When the client opts for fetching new transactions via the Bank API, cron will trigger periodic fetching
|
||||
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
|
||||
|
||||
### Database Schema
|
||||
|
||||
```mermaid
|
||||
classDiagram
|
||||
direction BT
|
||||
class alembic_version {
|
||||
varchar(32) version_num
|
||||
}
|
||||
class categories {
|
||||
varchar(100) name
|
||||
varchar(255) description
|
||||
char(36) user_id
|
||||
int(11) id
|
||||
}
|
||||
class category_transaction {
|
||||
int(11) category_id
|
||||
int(11) transaction_id
|
||||
}
|
||||
class oauth_account {
|
||||
char(36) user_id
|
||||
varchar(100) oauth_name
|
||||
varchar(4096) access_token
|
||||
int(11) expires_at
|
||||
varchar(1024) refresh_token
|
||||
varchar(320) account_id
|
||||
varchar(320) account_email
|
||||
char(36) id
|
||||
}
|
||||
class transaction {
|
||||
blob amount
|
||||
blob description
|
||||
char(36) user_id
|
||||
date date
|
||||
int(11) id
|
||||
}
|
||||
class user {
|
||||
varchar(100) first_name
|
||||
varchar(100) last_name
|
||||
varchar(320) email
|
||||
varchar(1024) hashed_password
|
||||
tinyint(1) is_active
|
||||
tinyint(1) is_superuser
|
||||
tinyint(1) is_verified
|
||||
longtext config
|
||||
char(36) id
|
||||
}
|
||||
|
||||
categories --> user: user_id -> id
|
||||
category_transaction --> categories: category_id -> id
|
||||
category_transaction --> transaction: transaction_id -> id
|
||||
oauth_account --> user: user_id -> id
|
||||
transaction --> user: user_id -> id
|
||||
```
|
||||
|
||||
### Features
|
||||
|
||||
@@ -62,6 +116,9 @@ The workflow works in the following way:
|
||||
- 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
|
||||
|
||||
@@ -69,15 +126,21 @@ The workflow works in the following way:
|
||||
login/registration, shows latest transactions, filtering, and allows adding transactions.
|
||||
- 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.
|
||||
- Worker service (backend/app/workers): Celery worker handling asynchronous tasks (e.g., sending verification emails,
|
||||
future background processing).
|
||||
- Database (PostgreSQL): Persists users, categories, transactions; schema managed by Alembic migrations.
|
||||
- Message Queue (RabbitMQ): Transports background jobs from the API to the worker.
|
||||
- Cache/Result Store (Redis): Available for caching or Celery result backend.
|
||||
- Infrastructure as Code (tofu/): OpenTofu modules provisioning cluster services (RabbitMQ, Redis, Argo CD,
|
||||
cert-manager, Cloudflare tunnel, etc.).
|
||||
- Worker service (backend/app/workers): Celery worker handling background tasks (emails, transactions fetching).
|
||||
- Database (MariaDB with Maxscale): Persists users, categories, transactions; schema managed by Alembic migrations.
|
||||
- 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.
|
||||
|
||||
### Other services deployed in the cluster
|
||||
|
||||
- Longhorn: distributed storage system providing persistent volumes for the database and other services
|
||||
- Prometheus + Grafana: monitoring stack collecting metrics from the app and cluster, visualized in Grafana dashboards
|
||||
- MariaDB operator: manages the MariaDB cluster based on Custom resources, creates Databases, users, handles backups
|
||||
- RabbitMQ operator: manages RabbitMQ cluster based on Custom resources
|
||||
- Cloudflare Tunnel: allows public access to backend API running in the private cluster, providing HTTPS
|
||||
|
||||
### Technologies Used
|
||||
|
||||
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||
@@ -90,10 +153,15 @@ The workflow works in the following way:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Here are software and hardware prerequisites for the development and production environments. This section also
|
||||
describes
|
||||
necessary environment variables and key dependencies used in the project.
|
||||
|
||||
### System Requirements
|
||||
|
||||
#### Development
|
||||
|
||||
- OS: Tested on MacOS, Linux and Windows should work as well
|
||||
- Minimum RAM: 8 GB
|
||||
- Storage: 10 GB+ free
|
||||
|
||||
@@ -137,10 +205,10 @@ The workflow works in the following way:
|
||||
#### 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
|
||||
[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
|
||||
@@ -167,7 +235,7 @@ You can run the project with Docker Compose and Python virtual environment for t
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dat515-2025/Group-8.git
|
||||
cd Group-8/7project
|
||||
cd Group-8/7project/src
|
||||
```
|
||||
|
||||
### 2) Install dependencies
|
||||
@@ -196,17 +264,18 @@ bash upgrade_database.sh
|
||||
|
||||
### 5) Run backend
|
||||
|
||||
Before running the backend, make sure to set the necessary environment variables. Either by setting them in your shell
|
||||
or by setting them in run configuration in your IDE.
|
||||
|
||||
```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
|
||||
cd Group-8/7project/src/backend
|
||||
source .venv/bin/activate
|
||||
celery -A app.celery_app.celery_app worker -l info
|
||||
```
|
||||
@@ -226,8 +295,11 @@ npm run dev
|
||||
|
||||
### Backend
|
||||
|
||||
App is separated into backend and frontend so it also needs to be built separately. Backend is build into docker image
|
||||
and frontend is deployed as static files.
|
||||
|
||||
```bash
|
||||
cd 7project/backend
|
||||
cd 7project/src/backend
|
||||
# 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 .
|
||||
@@ -236,16 +308,20 @@ docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
||||
### Frontend
|
||||
|
||||
```bash
|
||||
cd project7/frontend
|
||||
cd project7/src/frontend
|
||||
npm ci
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Deployment Instructions
|
||||
|
||||
Deployment is tested on TalosOS cluster with 1 control plane and 4 workers, cluster needs to be setup and configured
|
||||
manually. Terraform/OpenTofu is then used to deploy base services to the cluster. App itself is deployed automatically
|
||||
via GitHub actions and Helm chart. Frontend files are deployed to Cloudflare pages.
|
||||
|
||||
### Setup Cluster
|
||||
|
||||
Deployment should work on any Kubernetes cluster. However, we are using 4 TalosOS virtual machines (1 control plane, 3
|
||||
Deployment should work on any Kubernetes cluster. However, we are using 5 TalosOS virtual machines (1 control plane, 4
|
||||
workers)
|
||||
running on top of Proxmox VE.
|
||||
|
||||
@@ -255,7 +331,7 @@ running on top of Proxmox VE.
|
||||
4) Navigate to tofu directory
|
||||
|
||||
```bash
|
||||
cd 7project/tofu
|
||||
cd 7project/src/tofu
|
||||
````
|
||||
|
||||
5) Set IP addresses in environment variables
|
||||
@@ -418,37 +494,18 @@ tofu apply
|
||||
- UNIRATE_API_KEY
|
||||
5) On Github open Actions tab, select "Deploy Prod" and run workflow manually
|
||||
|
||||
# TODO: REMOVE I guess
|
||||
|
||||
2) Deploy the app using Helm
|
||||
|
||||
```bash
|
||||
# Set the namespace
|
||||
kubectl create namespace myapp || true
|
||||
|
||||
# Install/upgrade the chart with required values
|
||||
helm upgrade --install myapp charts/myapp-chart \
|
||||
-n myapp \
|
||||
-f charts/myapp-chart/values.yaml \
|
||||
--set image.backend.repository=myorg/myapp-backend \
|
||||
--set image.backend.tag=latest \
|
||||
--set env.BACKEND_URL="https://myapp.example.com" \
|
||||
--set env.FRONTEND_URL="https://myapp.example.com" \
|
||||
--set env.SECRET="CHANGE_ME_SECRET"
|
||||
```
|
||||
|
||||
## 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.
|
||||
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)
|
||||
that will start a [test DB container](backend/docker-compose.test.yml) and remove it afterward.
|
||||
If you want to run the tests locally, the preferred way is to use a [bash script](backend/test_locally.sh)
|
||||
that will start a test DB container with [docker compose](backend/docker-compose.test.yml) and remove it afterwards.
|
||||
|
||||
```bash
|
||||
cd 7project/backend
|
||||
bash test-with-ephemeral-mariadb.sh
|
||||
cd 7project/src/backend
|
||||
bash test_locally.sh
|
||||
```
|
||||
|
||||
### Unit Tests
|
||||
@@ -456,7 +513,7 @@ bash test-with-ephemeral-mariadb.sh
|
||||
There are only 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
|
||||
@@ -464,7 +521,7 @@ bash test-with-ephemeral-mariadb.sh --only-unit
|
||||
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
|
||||
@@ -472,7 +529,7 @@ bash test-with-ephemeral-mariadb.sh --only-integration
|
||||
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
|
||||
@@ -505,7 +562,12 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
### Frontend
|
||||
|
||||
- Start with: npm run dev in 7project/frontend
|
||||
- Start with:
|
||||
|
||||
```bash
|
||||
npm run dev in 7project/src/frontend
|
||||
```
|
||||
|
||||
- Ensure VITE_BACKEND_URL is set to the backend URL (e.g., http://127.0.0.1:8000)
|
||||
- Open http://localhost:5173
|
||||
- Login, view latest transactions, filter, and add new transactions from the UI.
|
||||
@@ -514,37 +576,72 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
## Presentation Video
|
||||
|
||||
**YouTube Link**: [Insert your YouTube link here]
|
||||
**YouTube Link**: https://youtu.be/FKR85AVN8bI
|
||||
|
||||
**Duration**: [X minutes Y seconds]
|
||||
**Duration**: 9 minutes 43 seconds
|
||||
|
||||
**Video Includes**:
|
||||
|
||||
- [ ] Project overview and architecture
|
||||
- [ ] Live demonstration of key features
|
||||
- [ ] Code walkthrough
|
||||
- [ ] Build and deployment showcase
|
||||
- [x] Project overview and architecture
|
||||
- [x] Live demonstration of key features
|
||||
- [x] Code walkthrough
|
||||
- [x] Build and deployment showcase
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Issue 1: [Common problem]
|
||||
#### Issue 1: Unable to apply Cloudflare terraform module
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
**Symptoms**: Terraform/OpenTofu apply fails during Cloudflare module deployment.
|
||||
This is caused by unknown variable not known beforehand.
|
||||
|
||||
#### Issue 2: [Another common problem]
|
||||
**Solution**: Apply first without Cloudflare module and then apply again.
|
||||
|
||||
**Symptoms**: [What the user sees]
|
||||
**Solution**: [Step-by-step fix]
|
||||
```bash
|
||||
tofu apply -exclude modules.cloudflare
|
||||
tofu apply
|
||||
```
|
||||
|
||||
#### Issue 2: Pods are unable to start
|
||||
|
||||
**Symptoms**: Pods are unable to start with ImagePullBackOff error. This could be caused
|
||||
by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
**Solution**: Make sure you updated the cluster config to use registry mirror as described in
|
||||
"Setup Cluster" section.
|
||||
|
||||
### Debug Commands
|
||||
|
||||
Get a detailed description of the Deployment:
|
||||
|
||||
```bash
|
||||
# Useful commands for debugging
|
||||
# Log viewing commands
|
||||
# Service status checks
|
||||
kubectl describe deployment finance-tracker -n prod
|
||||
```
|
||||
|
||||
Get a list of pods in the Deployment:
|
||||
|
||||
```bash
|
||||
kubectl get pods -n prod
|
||||
```
|
||||
|
||||
Check the logs of a specific pod copy value for <pod-name> from the command above (--previous flag shows logs of a
|
||||
failing pod, remove it if the pod is not failing):
|
||||
|
||||
```bash
|
||||
kubectl logs <pod-name> -n prod --previous
|
||||
```
|
||||
|
||||
See the service description:
|
||||
|
||||
```bash
|
||||
kubectl describe service finance-tracker -n prod
|
||||
```
|
||||
|
||||
Connect to the pod and run a bash shell:
|
||||
|
||||
```bash
|
||||
kubectl exec -it <pod-name> -n prod -- /bin/bash
|
||||
```
|
||||
|
||||
---
|
||||
@@ -555,34 +652,30 @@ 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 |
|
||||
|-------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------|------------|-----------------------------------------------------------------------------------------------------|
|
||||
| [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] |
|
||||
| [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 | ✅ 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] |
|
||||
| [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 | 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] |
|
||||
| [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] |
|
||||
|
||||
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||
|:----------------------------------------------------------------------------------------------------------|:------------|:-----------|:-----------|:-----------|:------|
|
||||
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8/pull/1) | Both | ✅ Complete | 10 Hours | Medium | |
|
||||
| [Design Document](https://github.com/dat515-2025/Group-8/commit/f09f9eaa82d0953afe41f33c57ff63e0933a81ef) | Both | ✅ Complete | 4 Hours | Easy | |
|
||||
| [Cluster setup ](https://github.com/dat515-2025/Group-8/commit/c8048d940df00874c290d99cdb4ad366bca6e95d) | Lukas | ✅ Complete | 30 hours | Hard | |
|
||||
| [Backend API Development](https://github.com/dat515-2025/Group-8/pull/26) | Dejan | ✅ Complete | 22 hours | Medium | |
|
||||
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/pull/19) | Lukas | ✅ Complete | 5 hours | Medium | |
|
||||
| [Frontend Development](https://github.com/dat515-2025/Group-8/pull/28) | Dejan | ✅ Complete | 32 hours | Medium | |
|
||||
| [Docker Configuration](https://github.com/dat515-2025/Group-8/pull/1) | Lukas | ✅ Complete | 3 hours | Easy | |
|
||||
| [Authentification](https://github.com/dat515-2025/Group-8/pull/23) | Both | ✅ Complete | 11 hours | Medium | |
|
||||
| [Transactions loading](https://github.com/dat515-2025/Group-8/pull/32) | Lukas | ✅ Complete | 7 hours | Medium | |
|
||||
| [Monitoring](https://github.com/dat515-2025/Group-8/pull/42/) | Lukas | ✅ Complete | 9 hours | Medium | |
|
||||
| [Cloud Deployment](https://github.com/dat515-2025/Group-8/pull/16) | Both | ✅ Complete | 21 hours | Hard | |
|
||||
| [Testing Implementation](https://github.com/dat515-2025/Group-8/pull/31/) | Both | ✅ Complete | 21 hours | Medium | |
|
||||
| [Documentation](https://github.com/dat515-2025/Group-8/commit/515106b238bc032d5f7d5dcae931b5cb7ee2a281) | Both | ✅ Complete | 14 hours | Medium | |
|
||||
| [Presentation Video](https://youtu.be/FKR85AVN8bI) | Both | ✅ Complete | 3 hours | Medium | |
|
||||
|
||||
## Hour Sheet
|
||||
|
||||
> Link to the specific commit on GitHub for each contribution.
|
||||
|
||||
### [Lukáš]
|
||||
|
||||
## Hour Sheet
|
||||
|
||||
**Name:** Lukáš Trkan
|
||||
### Lukáš
|
||||
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:----------------|:----------------------------|:--------|:------------------------------------------------------------------------------------|:------------------------------------------------------|
|
||||
| 18.9. - 19.9. | Initial Setup & Design | 40 | Repository init, system design diagrams, basic Terraform setup | `feat(infrastructure): add basic terraform resources` |
|
||||
| 18.9. - 19.9. | Initial Setup & Design | 10 | Repository init, system design diagrams, basic Terraform setup | `feat(infrastructure): add basic terraform resources` |
|
||||
| 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` |
|
||||
@@ -595,25 +688,31 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
| 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** | | |
|
||||
| 18.9 - 16.11 | Documentation | 8 | Updated report.md, design docs, and tfvars.example | `Create design.md`, `update report` |
|
||||
| 15.11 | Video | 2 | Record my video part, edit video | |
|
||||
| **Total** | | **107** | | |
|
||||
|
||||
### Dejan
|
||||
|
||||
| Date | Activity | Hours | Description |
|
||||
|-----------------|----------------------|--------|---------------------------------------------------------------|
|
||||
| 25.9. | Design | 2 | 6design |
|
||||
| 9.10 to 11.10. | Backend APIs | 12 | Implemented Backend APIs |
|
||||
| 13.10 to 15.10. | Frontend Development | 8 | Created user interface mockups |
|
||||
| Continually | Documentation | 6 | Documenting the dev process |
|
||||
| 21.10 to 23.10 | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement |
|
||||
| 28.10 to 30.10 | CI | 6 | Integrated tests with test database setup on github workflows |
|
||||
| 28.10 to 30.10 | Frontend | 7 | UI improvements and exchange rate API integration |
|
||||
| 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e |
|
||||
| 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices |
|
||||
| **Total** | | **63** | |
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:-----------------|:---------------------|:-------|:----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||
| 25.9. | Design | 2 | 6design | |
|
||||
| 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 | `PR #28`, `frontend basics` |
|
||||
| 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/CD | 6 | Integrated tests with test database setup on github workflows | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
||||
| 28.10. to 30.10. | Frontend | 8 | UI improvements and exchange rate API integration | `PR #35`, `34 improve frontend functionality` |
|
||||
| 29.10. | Backend | 4 | Token invalidation, few fixes | `PR #38`, `fix(backend): implemented jwt token invalidation so users cannot use …` |
|
||||
| 4.11. to 6.11. | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #45`, `feat(test): added more tests ` |
|
||||
| 4.11. to 6.11. | Frontend | 8 | Fixes, rates API, Improved UI, added support for mobile devices | `PR #41, #44`, `feat(frontend): added CNB API and moved management into a new tab`, `43 fix the UI layout in chrome ` |
|
||||
| 11.11. | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `feat(backend): Moved the unirate API to the backend `, `feat(backend): moved mock bank to backend` |
|
||||
| 11.11. to 12.11. | Tests | 3 | Local testing DB container, few fixes | `PR #48`, `fix(tests): fixed test runtime errors regarding database connection ` |
|
||||
| 12.11. | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `feat(frontend): implemented multiple transaction selections in UI` |
|
||||
| 13.11. | Video | 3 | Video | |
|
||||
| 25.9. to 14.11. | Documentation | 8 | Documenting the dev process | multiple `feat(docs): report.md update` |
|
||||
| **Total** | | **87** | | |
|
||||
|
||||
### Group Total: [XXX.X] hours
|
||||
### Group Total: 194 hours
|
||||
|
||||
---
|
||||
|
||||
@@ -621,27 +720,58 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
||||
|
||||
### What We Learned
|
||||
|
||||
[Reflect on the key technical and collaboration skills learned during this project]
|
||||
#### Technical
|
||||
|
||||
- We learned how to use AI to help us with our project.
|
||||
- We learned how to use Copilot for PR reviews.
|
||||
- We learned how to troubleshoot issues with our project in different areas.
|
||||
|
||||
#### Collaboration
|
||||
|
||||
- Weekly meetings with the TA were great for syncing up on progress, discussing issues, planning future work.
|
||||
- Using GitHub issues and pull requests was very helpful for keeping track of progress.
|
||||
|
||||
### Challenges Faced
|
||||
|
||||
#### 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
|
||||
|
||||
[Describe the main challenges and how you overcame them]
|
||||
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.
|
||||
|
||||
#### Not enough time to implement all features
|
||||
|
||||
Since this course is worth only 5 credits, we often had to prioritize other courses we were attending over this project.
|
||||
In the end, we were able to implement all necessary features.
|
||||
|
||||
### 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.
|
||||
|
||||
#### Private container registry
|
||||
|
||||
Using private container registry would allow us to include environment variables directly in the image during build.
|
||||
This would simplify deployment and CI/CD setup.
|
||||
|
||||
#### Start sooner
|
||||
|
||||
The weekly meetings helped us to start planning the project earlier and avoid spending too much time on details,
|
||||
but we could have started earlier if we had more time.
|
||||
|
||||
[What would you do differently? What worked well that you'd keep?]
|
||||
|
||||
### Individual Growth
|
||||
|
||||
#### [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.
|
||||
|
||||
@@ -651,14 +781,25 @@ The biggest challenge for me was time tracking since I am used to tracking to pr
|
||||
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]
|
||||
#### [Dejan]
|
||||
|
||||
#### [Team Member 2 Name]
|
||||
Since I do not have a job and I am more theoretically oriented student (I am more into math, algorithms, cryptography),
|
||||
this project was probably the most complex one I have ever worked on.
|
||||
For me, it was a great experience to work on an actually deployed fullstack app and not only local development, that I
|
||||
was used to from the past.
|
||||
|
||||
It was also a great experience to collaborate with Lukas who has prior experience with app deployment and
|
||||
infrastructure.
|
||||
Thanks to this, I learned a lot new technologies and how to work in a team (First time reviewing PRs).
|
||||
|
||||
It was challenging to wrap my head around the project structure and how everything was connected (And I still think I
|
||||
have some gaps in my knowledge).
|
||||
But I think that if I decide to create my own demo project in the future, I will definitely be able to work on it much
|
||||
more efficiently.
|
||||
|
||||
[Personal reflection on growth, challenges, and learning]
|
||||
|
||||
|
||||
---
|
||||
|
||||
**Report Completion Date**: [Date]
|
||||
**Last Updated**: 15.10.2025
|
||||
**Report Completion Date**: 15.11.2025
|
||||
**Last Updated**: 15.11.2025
|
||||
14
7project/src/README.md
Normal file
14
7project/src/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
## Folder structure
|
||||
|
||||
- `src/`
|
||||
- `backend/` - Python FastAPI backend application. Described in separate [README](./backend/README.md).
|
||||
- `charts/`
|
||||
- `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments. Described in
|
||||
separate [README](./charts/README.md).
|
||||
- `frontend/` - React frontend application. Described in separate
|
||||
[README](./frontend/README.md).
|
||||
- `tofu/` - Terraform/OpenTofu services deployment configurations. Described in separate
|
||||
[README](./tofu/README.md).
|
||||
- `compose.yaml` - Docker Compose file for local development
|
||||
- `create_migration.sh` - script to create new Alembic database migration
|
||||
- `upgrade_database.sh` - script to upgrade database to latest Alembic revision
|
||||
8
7project/src/backend/.idea/.gitignore
generated
vendored
Normal file
8
7project/src/backend/.idea/.gitignore
generated
vendored
Normal file
@@ -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
|
||||
16
7project/src/backend/Dockerfile
Normal file
16
7project/src/backend/Dockerfile
Normal file
@@ -0,0 +1,16 @@
|
||||
FROM python:3.11-slim
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
RUN useradd --create-home --shell /bin/bash app
|
||||
|
||||
COPY requirements.txt .
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
COPY . .
|
||||
RUN chown -R app:app /app
|
||||
|
||||
USER app
|
||||
|
||||
EXPOSE 8000
|
||||
CMD ["sh", "-c", "alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 8000"]
|
||||
23
7project/src/backend/README.md
Normal file
23
7project/src/backend/README.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Backend
|
||||
|
||||
This directory contains the backend code for the project. It is built using Python and FastAPI framework and with
|
||||
database migrations support using Alembic.
|
||||
|
||||
## Directory structure
|
||||
|
||||
- `alembic/` - database migrations
|
||||
- `app/` - main application code
|
||||
- `api/` - API endpoints - routers/controllers with request handling logic
|
||||
- `core/` - core application logic - database session management, security
|
||||
- `models/` - database models
|
||||
- `schemas/` - Endpoint schemas
|
||||
- `services/` - utilities for various tasks
|
||||
- `workers/` - background tasks
|
||||
- `app.py` - FastAPI startup script
|
||||
- `celery_app.py` - Celery startup script
|
||||
- `tests/` - tests
|
||||
- `docker-compose.test.yml` - docker compose for testing database
|
||||
- `Dockerfile` - production Dockerfile
|
||||
- `main.py` - App entrypoint
|
||||
- `requirements.txt` - Python dependencies
|
||||
- `test_locally.sh` - script to run tests with temporary database
|
||||
@@ -14,11 +14,10 @@ from httpx_oauth.oauth2 import BaseOAuth2
|
||||
|
||||
from app.models.user import User
|
||||
from app.oauth.bank_id import BankID
|
||||
from app.oauth.csas import CSASOAuth
|
||||
from app.workers.celery_tasks import send_email
|
||||
from app.oauth.custom_openid import CustomOpenID
|
||||
from app.oauth.moje_id import MojeIDOAuth
|
||||
from app.services.db import get_user_db
|
||||
from app.core.queue import enqueue_email
|
||||
|
||||
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
||||
|
||||
@@ -87,7 +86,7 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
||||
"Pokud jsi registraci neprováděl(a), tento email ignoruj.\n"
|
||||
)
|
||||
try:
|
||||
enqueue_email(to=user.email, subject=subject, body=body)
|
||||
send_email.delay(user.email, subject, body)
|
||||
except Exception as e:
|
||||
print("[Email Fallback] To:", user.email)
|
||||
print("[Email Fallback] Subject:", subject)
|
||||
4
7project/src/backend/main.py
Normal file
4
7project/src/backend/main.py
Normal file
@@ -0,0 +1,4 @@
|
||||
import uvicorn
|
||||
|
||||
if __name__ == "__main__":
|
||||
uvicorn.run("app.app:fastApi", host="0.0.0.0", log_level="info")
|
||||
@@ -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-with-ephemeral-mariadb.sh --only-integration -k "login"
|
||||
# ./test-with-ephemeral-mariadb.sh --only-e2e -vv
|
||||
# ./test_locally.sh --only-unit -q
|
||||
# ./test_locally.sh --only-integration -k "login"
|
||||
# ./test_locally.sh --only-e2e -vv
|
||||
#
|
||||
# This script will:
|
||||
# 1) Start a MariaDB 11.4 container (ephemeral storage, port 3307)
|
||||
@@ -34,15 +34,16 @@ def test_authenticated_route_requires_auth(client):
|
||||
async def test_on_after_request_verify_enqueues_email(monkeypatch):
|
||||
calls = {}
|
||||
|
||||
def fake_enqueue_email(to: str, subject: str, body: str):
|
||||
calls.setdefault("emails", []).append({
|
||||
"to": to,
|
||||
"subject": subject,
|
||||
"body": body,
|
||||
})
|
||||
class FakeCeleryTask:
|
||||
def delay(to: str, subject: str, body: str):
|
||||
calls.setdefault("emails", []).append({
|
||||
"to": to,
|
||||
"subject": subject,
|
||||
"body": body,
|
||||
})
|
||||
|
||||
# Patch the enqueue_email used inside user_service
|
||||
monkeypatch.setattr(user_service, "enqueue_email", fake_enqueue_email)
|
||||
monkeypatch.setattr(user_service, "send_email", FakeCeleryTask)
|
||||
|
||||
class DummyUser:
|
||||
def __init__(self, email):
|
||||
30
7project/src/charts/README.md
Normal file
30
7project/src/charts/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Helm chart deployment
|
||||
|
||||
This directory contains a Helm chart for deploying the app to a cluster, it support bot production and preview
|
||||
deployment.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
- `myapp-chart/`
|
||||
- `templates/`
|
||||
- `app-deployment.yaml` - Kubernetes Deployment for the application
|
||||
- `cron.yaml` - cronjob for periodic tasks - periodically calls app endpoint
|
||||
- `database.yaml` - Creates database using MariaDB operator. Production database is kept, but preview/dev
|
||||
database is dropped after uninstalling the chart.
|
||||
- `database-grant.yaml` - Defines rights for the database user
|
||||
- `database-user.yaml` - Creates database user
|
||||
- `monitoring.yaml` - Adds /metrics endpoint to Prometheus scraping
|
||||
- `prod.yaml` - Application secrets
|
||||
- `rabbitmq-cluster.yaml` - Defines RabbitMQ cluster for this deployment
|
||||
- `rabbitmq-permission.yalm` - Defines RabbitMQ user permissions
|
||||
- `rabbitmq-queue.yaml` - Defines RabbitMQ queue
|
||||
- `rabbitmq-user.yaml` - Defines RabbitMQ user
|
||||
- `rabbitmq-user-secret.yaml` - Defines RabbitMQ user secret
|
||||
- `service.yaml` - Kubernetes Service for the application
|
||||
- `tunnel.yaml` - Cloudflare tunnel for accessing the application¨
|
||||
- `worker-deployment.yaml` - Kubernetes Deployment for the Celery worker, uses same image as the app-deployment,
|
||||
but with different entrypoint
|
||||
- `Chart.yaml` - Helm chart metadata
|
||||
- `values.yaml` - list of all configurable values
|
||||
- `values-dev.yaml` - default values for development/preview deployment
|
||||
- `values-prod.yaml` - default values for production deployment
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user