mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
15 Commits
merge/core
...
16f660ea5b
| Author | SHA1 | Date | |
|---|---|---|---|
|
16f660ea5b | ||
| 7a0d7dc4af | |||
| fabdff3bef | |||
| 1c1130b9b0 | |||
| 7d7698450d | |||
|
|
db9092b78f | ||
| 3557b3ea13 | |||
| 4a1a9f03a1 | |||
| b1be15f559 | |||
|
|
515106b238 | ||
|
|
b5290119e9 | ||
| 0beb889f5e | |||
|
|
0a96c32c93 | ||
|
|
f1034f6ed5 | ||
| 0f729d28d1 |
@@ -7,64 +7,65 @@ Focus on areas that align with your project goals and interests.
|
|||||||
The core deliverables are required.
|
The core deliverables are required.
|
||||||
This means that you must get at least 2 points for each item in this category.
|
This means that you must get at least 2 points for each item in this category.
|
||||||
|
|
||||||
| **Category** | **Item** | **Max Points** | **Points** | **Comments** |
|
| **Category** | **Item** | **Max Points** | **Points** | **Comment** |
|
||||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------| |
|
|:---------------------------------|:----------------------------------------|:---------------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **Core Deliverables (Required)** | | | | |
|
| **Core Deliverables (Required)** | | | | |
|
||||||
| Codebase & Organization | Well-organized project structure | 5 | 5 | |
|
| 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 | |
|
| | 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 | |
|
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | We used Github issues |
|
||||||
| | Proper version control usage | 5 | 5 | |
|
| | Proper version control usage | 5 | 5 | We used branches for development, pull request reviews |
|
||||||
| 23 | Complete source code | 5 | 5 | |
|
| 23 | Complete source code | 5 | 5 | The code is complete - entire codebase is in this repository |
|
||||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 | |
|
| 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 | 2 | |
|
| | Updated design document | 5 | 4 | Our design document was updated and merged into the report |
|
||||||
| | Clear build/deployment instructions | 5 | 2 | |
|
| | Clear build/deployment instructions | 5 | 5 | Should be clear |
|
||||||
| | Troubleshooting guide | 5 | 1 | |
|
| | Troubleshooting guide | 5 | 3 | When it comes to troubleshooting, there is never enough documentation |
|
||||||
| | Completed self-assessment table | 5 | 2 | |
|
| | Completed self-assessment table | 5 | 5 | Completed. |
|
||||||
| 14 | Hour sheets for all members | 5 | 3 | |
|
| 32 | Hour sheets for all members | 5 | 5 | Filled. |
|
||||||
| Presentation Video | Project demonstration | 5 | 0 | |
|
| Presentation Video | Project demonstration | 5 | 5 | Yes |
|
||||||
| | Code walk-through | 5 | 0 | |
|
| | 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. |
|
||||||
| 0 | Deployment showcase | 5 | 0 | |
|
| 13 | Deployment showcase | 5 | 5 | Yes |
|
||||||
| **Technical Implementation** | | | | |
|
| **Technical Implementation** | | | | |
|
||||||
| Application Functionality | Basic functionality works | 10 | 8 | |
|
| Application Functionality | Basic functionality works | 10 | 10 | The app works as intended |
|
||||||
| | Advanced features implemented | 10 | 0 | |
|
| | Advanced features implemented | 10 | 5 | OAuth, BankAPI connection (not only mock bank) |
|
||||||
| | Error handling & robustness | 10 | 4 | |
|
| | Error handling & robustness | 10 | 5 | App notifies user about errors, errors in code are also logged by sentry and we get notified |
|
||||||
| 16 | User-friendly interface | 5 | 4 | |
|
| 24 | User-friendly interface | 5 | 4 | Responsive interface with dark mode support, should by user friendly enough |
|
||||||
| Backend & Architecture | Stateless web server | 5 | 5 | |
|
| Backend & Architecture | Stateless web server | 5 | 5 | Yes, the web server is stateless - authentication uses JWT, not sessions. |
|
||||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN | |
|
| | Stateful application | 10 | 10 | Yes, the app is stateful - data are persistently stored in database |
|
||||||
| | Database integration | 10 | 10 | |
|
| | 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 | |
|
| | API design | 5 | 5 | Backend APIs are implemented with public Swagger docs |
|
||||||
| 20 | Microservices architecture | 10 | 0 | |
|
| 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 | |
|
| Cloud Integration | Basic cloud deployment | 10 | 10 | Yes (In private cluster), using GH Actions and self-hosted runner. |
|
||||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN | |
|
| | Cloud APIs usage | 10 | 8 | GH Actions deploys frontend to Cloudflare Pages, deployment creates CF tunnel record automatically |
|
||||||
| | Serverless components | 10 | 0 | |
|
| | Serverless components | 10 | 10 | We are using CF pages for frontend deployment |
|
||||||
| 10 | Advanced cloud services | 5 | 0 | |
|
| 33 | Advanced cloud services | 5 | 5 | Using CF provides us with DDOS protection, access rules, it hides our IP |
|
||||||
| **DevOps & Deployment** | | | | |
|
| **DevOps & Deployment** | | | | |
|
||||||
| Containerization | Basic Dockerfile | 5 | 5 | |
|
| Containerization | Basic Dockerfile | 5 | 5 | Yes |
|
||||||
| | Optimized Dockerfile | 5 | 0 | |
|
| | Optimized Dockerfile | 5 | 5 | Rootless Dockerfile |
|
||||||
| | Docker Compose | 5 | 5 - dev only | |
|
| | Docker Compose | 5 | 5 | For development environment |
|
||||||
| 15 | Persistent storage | 5 | 5 | |
|
| 20 | Persistent storage | 5 | 5 | Yes, using Longhorn. |
|
||||||
| Deployment & Scaling | Manual deployment | 5 | 5 | |
|
| Deployment & Scaling | Manual deployment | 5 | 5 | Yes, possible by using Helm manually |
|
||||||
| | Automated deployment | 5 | 5 | |
|
| | Automated deployment | 5 | 5 | Yes, with Github actions |
|
||||||
| | Multiple replicas | 5 | 5 | |
|
| | Multiple replicas | 5 | 5 | Yes, 3 pods with API, 3 pods with workers, 3 database pods |
|
||||||
| 20 | Kubernetes deployment | 10 | 10 | |
|
| 25 | Kubernetes deployment | 10 | 10 | Yes |
|
||||||
| **Quality Assurance** | | | | |
|
| **Quality Assurance** | | | | |
|
||||||
| Testing | Unit tests | 5 | 2 | |
|
| Testing | Unit tests | 5 | 4 | All workflows are covered by tests |
|
||||||
| | Integration tests | 5 | 2 | |
|
| | Integration tests | 5 | 5 | Yes |
|
||||||
| | End-to-end tests | 5 | 5 | |
|
| | End-to-end tests | 5 | 5 | Yes |
|
||||||
| 9 | Performance testing | 5 | 0 | |
|
| 14 | Performance testing | 5 | 0 | No |
|
||||||
| Monitoring & Operations | Health checks | 5 | 5 | |
|
| Monitoring & Operations | Health checks | 5 | 5 | Yes |
|
||||||
| | Logging | 5 | 2 - only to terminal add logstash | |
|
| | Logging | 5 | 4 | Logs can be accessed easily using Grafana |
|
||||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint | |
|
| | Metrics/Monitoring | 2 | 2 | Yes, visualised in Grafana |
|
||||||
| Security | HTTPS/TLS | 5 | 5 | |
|
| 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. |
|
||||||
| | Authentication | 5 | 5 | |
|
| Security | HTTPS/TLS | 5 | 5 | Yes |
|
||||||
| 15 | Authorization | 5 | 5 | |
|
| | Authentication | 5 | 5 | Yes |
|
||||||
| **Innovation & Excellence** | | | | |
|
| 15 | Authorization | 5 | 5 | Yes |
|
||||||
| Advanced Features and | AI/ML Integration | 10 | 0 | |
|
| **Innovation & Excellence** | | | | |
|
||||||
| Technical Excellence | Real-time features | 10 | 0 | |
|
| Advanced Features and | AI/ML Integration | 10 | 0 | No |
|
||||||
| | Creative problem solving | 10 | ? | |
|
| Technical Excellence | Real-time features | 10 | 0 | No |
|
||||||
| | Performance optimization | 5 | 2 | |
|
| | Creative problem solving | 10 | 4 | Cron jobs for bank scraping |
|
||||||
| 2 | Exceptional user experience | 5 | 0 | |
|
| | Performance optimization | 5 | 4 | Delegating emails and scraping to workers, hosting frontend on CF |
|
||||||
| **Total** | | **255** | **153** | |
|
| 11 | Exceptional user experience | 5 | 3 | |
|
||||||
|
| **Total** | | **255** | **257** | |
|
||||||
|
|
||||||
## Grading Scale
|
## 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**
|
- **Maximum: 200+ points**
|
||||||
|
|
||||||
| Grade | Points |
|
| Grade | Points |
|
||||||
| ----- | -------- |
|
|-------|----------|
|
||||||
| A | 180-200+ |
|
| A | 180-200+ |
|
||||||
| B | 160-179 |
|
| B | 160-179 |
|
||||||
| C | 140-159 |
|
| C | 140-159 |
|
||||||
|
|||||||
@@ -56,6 +56,60 @@ The workflow works in the following way:
|
|||||||
using background worker.
|
using background worker.
|
||||||
- After successful load, these transactions are stored to the database and displayed to the client
|
- After successful load, these transactions are stored to the database and displayed to the client
|
||||||
|
|
||||||
|
### 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
|
### Features
|
||||||
|
|
||||||
- The stored transactions are encrypted in the DB for security reasons.
|
- The stored transactions are encrypted in the DB for security reasons.
|
||||||
@@ -79,6 +133,14 @@ The workflow works in the following way:
|
|||||||
etc.).
|
etc.).
|
||||||
- Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
|
- 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
|
### Technologies Used
|
||||||
|
|
||||||
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||||
@@ -173,7 +235,7 @@ You can run the project with Docker Compose and Python virtual environment for t
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/dat515-2025/Group-8.git
|
git clone https://github.com/dat515-2025/Group-8.git
|
||||||
cd Group-8/7project
|
cd Group-8/7project/src
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2) Install dependencies
|
### 2) Install dependencies
|
||||||
@@ -202,10 +264,11 @@ bash upgrade_database.sh
|
|||||||
|
|
||||||
### 5) Run backend
|
### 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
|
```bash
|
||||||
cd backend
|
cd backend
|
||||||
|
|
||||||
#TODO: set env variables
|
|
||||||
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -236,7 +299,7 @@ App is separated into backend and frontend so it also needs to be built separate
|
|||||||
and frontend is deployed as static files.
|
and frontend is deployed as static files.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd 7project/backend
|
cd 7project/src/backend
|
||||||
# Dont forget to set correct image tag with your registry and name
|
# 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
|
# 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 .
|
docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
||||||
@@ -258,7 +321,7 @@ via GitHub actions and Helm chart. Frontend files are deployed to Cloudflare pag
|
|||||||
|
|
||||||
### Setup Cluster
|
### 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)
|
workers)
|
||||||
running on top of Proxmox VE.
|
running on top of Proxmox VE.
|
||||||
|
|
||||||
@@ -513,16 +576,16 @@ npm run dev in 7project/src/frontend
|
|||||||
|
|
||||||
## Presentation Video
|
## 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**:
|
**Video Includes**:
|
||||||
|
|
||||||
- [ ] Project overview and architecture
|
- [x] Project overview and architecture
|
||||||
- [ ] Live demonstration of key features
|
- [x] Live demonstration of key features
|
||||||
- [ ] Code walkthrough
|
- [x] Code walkthrough
|
||||||
- [ ] Build and deployment showcase
|
- [x] Build and deployment showcase
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
@@ -550,10 +613,35 @@ by either hitting docker hub rate limits or by docker hub being down.
|
|||||||
|
|
||||||
### Debug Commands
|
### Debug Commands
|
||||||
|
|
||||||
|
Get a detailed description of the Deployment:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Useful commands for debugging
|
kubectl describe deployment finance-tracker -n prod
|
||||||
# Log viewing commands
|
```
|
||||||
# Service status checks
|
|
||||||
|
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
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -564,34 +652,30 @@ by either hitting docker hub rate limits or by docker hub being down.
|
|||||||
> This information is used for individual grading.
|
> This information is used for individual grading.
|
||||||
> Link to the specific commit on GitHub for each contribution.
|
> 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/pull/1) | Both | ✅ Complete | 10 Hours | Medium | |
|
||||||
| [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/commit/f09f9eaa82d0953afe41f33c57ff63e0933a81ef) | Both | ✅ Complete | 4 Hours | Easy | |
|
||||||
| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api) | Dejan | ✅ Complete | 12 hours | Medium | [Any notes] |
|
| [Cluster setup ](https://github.com/dat515-2025/Group-8/commit/c8048d940df00874c290d99cdb4ad366bca6e95d) | Lukas | ✅ Complete | 30 hours | Hard | |
|
||||||
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Backend API Development](https://github.com/dat515-2025/Group-8/pull/26) | Dejan | ✅ Complete | 22 hours | Medium | |
|
||||||
| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend) | Dejan | ✅ Complete | 17 hours | Medium | [Any notes] |
|
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/pull/19) | Lukas | ✅ Complete | 5 hours | Medium | |
|
||||||
| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml) | Lukas | ✅ Complete | 3 hours | Easy | [Any notes] |
|
| [Frontend Development](https://github.com/dat515-2025/Group-8/pull/28) | Dejan | ✅ Complete | 32 hours | Medium | |
|
||||||
| [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. |
|
| [Docker Configuration](https://github.com/dat515-2025/Group-8/pull/1) | Lukas | ✅ Complete | 3 hours | Easy | |
|
||||||
| [Testing Implementation](https://github.com/dat515-2025/group-name) | Dejan | ✅ Complete | 16 hours | Medium | [Any notes] |
|
| [Authentification](https://github.com/dat515-2025/Group-8/pull/23) | Both | ✅ Complete | 11 hours | Medium | |
|
||||||
| [Documentation](https://github.com/dat515-2025/group-name) | Both | 🔄 In Progress | [X hours] | Easy | [Any notes] |
|
| [Transactions loading](https://github.com/dat515-2025/Group-8/pull/32) | Lukas | ✅ Complete | 7 hours | Medium | |
|
||||||
| [Presentation Video](https://github.com/dat515-2025/group-name) | Both | ❌ Not Started | [X hours] | Medium | [Any notes] |
|
| [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 | |
|
||||||
**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started
|
| [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
|
## Hour Sheet
|
||||||
|
|
||||||
> Link to the specific commit on GitHub for each contribution.
|
### Lukáš
|
||||||
|
|
||||||
### [Lukáš]
|
|
||||||
|
|
||||||
## Hour Sheet
|
|
||||||
|
|
||||||
**Name:** Lukáš Trkan
|
|
||||||
|
|
||||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
| 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` |
|
| 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) |
|
| 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` |
|
| 10.10. - 11.10. | Backend | 5 | Implemented OAuth support (MojeID, BankID) | `feat(auth): add support for OAuth and MojeID` |
|
||||||
@@ -604,29 +688,31 @@ by either hitting docker hub rate limits or by docker hub being down.
|
|||||||
| 9.11. | Monitoring | 2 | Added custom Prometheus metrics | `PR #46` (Prometheus custom 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. | 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) |
|
| 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` |
|
| 18.9 - 16.11 | Documentation | 8 | Updated report.md, design docs, and tfvars.example | `Create design.md`, `update report` |
|
||||||
| **Total** | | **105** | | |
|
| 15.11 | Video | 2 | Record my video part, edit video | |
|
||||||
|
| **Total** | | **107** | | |
|
||||||
|
|
||||||
### Dejan
|
### Dejan
|
||||||
|
|
||||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||||
|:----------------|:---------------------|:-------|:--------------------------------------------------------------|:---------------------------------------------------------|
|
|:-----------------|:---------------------|:-------|:----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||||
| 25.9. | Design | 2 | 6design | |
|
| 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` |
|
| 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` |
|
| 13.10. to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
||||||
| Continually | Documentation | 7 | Documenting the dev process | |
|
| 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` |
|
||||||
| 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 | CI | 6 | Integrated tests with test database setup on github workflows | `PR #28`, `frontend basics` |
|
| 28.10. to 30.10. | Frontend | 8 | UI improvements and exchange rate API integration | `PR #35`, `34 improve frontend functionality` |
|
||||||
| 28.10 to 30.10 | Frontend | 8 | UI improvements and exchange rate API integration | `PR #28`, `frontend basics` |
|
| 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 #28`, `frontend basics` |
|
| 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 | 6 | Fixes, Improved UI, added support for mobile devices | `PR #28`, `frontend basics` |
|
| 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 | `PR #28`, `frontend basics` |
|
| 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 #28`, `frontend basics` |
|
| 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 | `PR #28`, `frontend basics` |
|
| 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 | |
|
| 13.11. | Video | 3 | Video | |
|
||||||
| **Total** | | **80** | | |
|
| 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
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -634,7 +720,16 @@ by either hitting docker hub rate limits or by docker hub being down.
|
|||||||
|
|
||||||
### What We Learned
|
### 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
|
### Challenges Faced
|
||||||
|
|
||||||
@@ -648,6 +743,11 @@ If the deployed module (helm chart for example) was not configured properly, it
|
|||||||
namespace that cannot be deleted.
|
namespace that cannot be deleted.
|
||||||
This was solved by using snapshots in Proxmox and restoring if this happened.
|
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
|
### If We Did This Again
|
||||||
|
|
||||||
#### Different framework
|
#### Different framework
|
||||||
@@ -661,6 +761,11 @@ Using .NET (which we considered initially) would probably solve these issues.
|
|||||||
Using private container registry would allow us to include environment variables directly in the image during build.
|
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.
|
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?]
|
[What would you do differently? What worked well that you'd keep?]
|
||||||
|
|
||||||
### Individual Growth
|
### Individual Growth
|
||||||
@@ -678,12 +783,23 @@ used not only by myself.
|
|||||||
|
|
||||||
#### [Dejan]
|
#### [Dejan]
|
||||||
|
|
||||||
Since I do not have a job, this project was probably the most complex one I have ever worked on.
|
Since I do not have a job and I am more theoretically oriented student (I am more into math, algorithms, cryptography),
|
||||||
It was also the first school project where I was encouraged to use AI.
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Report Completion Date**: [Date]
|
**Report Completion Date**: 15.11.2025
|
||||||
**Last Updated**: 13.11.2025
|
**Last Updated**: 15.11.2025
|
||||||
@@ -1,23 +1,14 @@
|
|||||||
## Folder structure
|
## Folder structure
|
||||||
|
|
||||||
- `src/`
|
- `src/`
|
||||||
- `backend/`
|
- `backend/` - Python FastAPI backend application. Described in separate [README](./backend/README.md).
|
||||||
- `alembic/` - database migrations
|
|
||||||
- `app/` - main application code
|
|
||||||
- `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
|
|
||||||
- `charts/`
|
- `charts/`
|
||||||
- `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments
|
- `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments. Described in
|
||||||
- `frontend/` - React frontend application
|
separate [README](./charts/README.md).
|
||||||
- `tofu/` - Terraform/OpenTofu services deployment configurations
|
- `frontend/` - React frontend application. Described in separate
|
||||||
- `modules/` - separated modules for different services
|
[README](./frontend/README.md).
|
||||||
- `main.tf` - main deployment configuration
|
- `tofu/` - Terraform/OpenTofu services deployment configurations. Described in separate
|
||||||
- `variables.tf` - deployment variables
|
[README](./tofu/README.md).
|
||||||
- `terraform.tfvars.example` - example variables file
|
|
||||||
- `compose.yaml` - Docker Compose file for local development
|
- `compose.yaml` - Docker Compose file for local development
|
||||||
- `create_migration.sh` - script to create new Alembic database migration
|
- `create_migration.sh` - script to create new Alembic database migration
|
||||||
- `upgrade_database.sh` - script to upgrade database to latest Alembic revision
|
- `upgrade_database.sh` - script to upgrade database to latest Alembic revision
|
||||||
@@ -1,8 +1,16 @@
|
|||||||
FROM python:3.11-trixie
|
FROM python:3.11-slim
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
|
RUN useradd --create-home --shell /bin/bash app
|
||||||
|
|
||||||
COPY requirements.txt .
|
COPY requirements.txt .
|
||||||
RUN pip install --no-cache-dir -r requirements.txt
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
RUN chown -R app:app /app
|
||||||
|
|
||||||
|
USER app
|
||||||
|
|
||||||
EXPOSE 8000
|
EXPOSE 8000
|
||||||
CMD alembic upgrade head && uvicorn app.app:fastApi --host 0.0.0.0 --port 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
|
||||||
@@ -1,73 +1,21 @@
|
|||||||
# React + TypeScript + Vite
|
# React + TypeScript + Vite
|
||||||
|
|
||||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
This directory contains the frontend code.
|
||||||
|
|
||||||
Currently, two official plugins are available:
|
## Directory Structure
|
||||||
|
|
||||||
- [@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
|
- `public/` - static files
|
||||||
- [@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
|
- `src/` - frontend code
|
||||||
|
- `assets/` - static assets
|
||||||
## React Compiler
|
- `pages/` - React pages
|
||||||
|
- `api.ts` - API client
|
||||||
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).
|
- `App.tsx` - React app
|
||||||
|
- `main.tsx` - entry point
|
||||||
## Expanding the ESLint configuration
|
- `index.css` - global styles
|
||||||
|
- `config.ts` - configuration
|
||||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
- `ui.css` - UI styles
|
||||||
|
- `vite.config.ts` - Vite configuration
|
||||||
```js
|
- `package.json` - NPM dependencies
|
||||||
export default defineConfig([
|
- `tsconfig.json` - TypeScript configuration
|
||||||
globalIgnores(['dist']),
|
- `index.html` - HTML template
|
||||||
{
|
-
|
||||||
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...
|
|
||||||
},
|
|
||||||
},
|
|
||||||
])
|
|
||||||
```
|
|
||||||
|
|||||||
61
todo.md
Normal file
61
todo.md
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
- sentry for error tracking
|
||||||
|
|
||||||
|
- github actions for ci/cd
|
||||||
|
- deployment using helmchart, prod + dev
|
||||||
|
- celery background tasks
|
||||||
|
- cron
|
||||||
|
- cloudflare tunnels
|
||||||
|
- mariadb operator for database, maxscale 3 nodes, phpmyadmin, maxscale ui, backups
|
||||||
|
- prometheus + grafana dashboards for monitoring
|
||||||
|
- rabbitmq message queue
|
||||||
|
- longhorn for file storage (edited talosos deployment)
|
||||||
|
|
||||||
|
Aplikace:
|
||||||
|
|
||||||
|
- umíme oauth - mojeid, bankid => oboje se používá i pro autorizaci komunikace s CZ státem
|
||||||
|
- automatický import plateb z banky
|
||||||
|
- ukázat frontend
|
||||||
|
- ukázat backend - oauth, celery tasky,
|
||||||
|
- alembic na migrace db
|
||||||
|
- sentry integrace
|
||||||
|
|
||||||
|
Infrastruktura:
|
||||||
|
|
||||||
|
- běžíme na proxmoxu
|
||||||
|
- kubernetes cluster přes TalosOS jako virtuálky with edited configs
|
||||||
|
- deployment služeb přes tofu/terraform
|
||||||
|
- longhorn pro persistentní storage
|
||||||
|
- mariadb operator s maxscale - 3 nody + phpmyadmin
|
||||||
|
- prometheus + grafana monitoring
|
||||||
|
- rabbitmq message queue pro background tasky
|
||||||
|
- veřejný přístup přes cloudflare tunnels
|
||||||
|
- ukázat headlamp map
|
||||||
|
- build v github actions
|
||||||
|
- deployment pomocí helmchartu prod + dev prostředí pomocí selfhosted runneru
|
||||||
|
- remote access do clusteru přes tailscale
|
||||||
|
-
|
||||||
|
|
||||||
|
Where to put description of infrastructure components? for example Helm chart of app is quite large
|
||||||
|
How about readme?
|
||||||
|
|
||||||
|
linking commits in time table? I cant link all of them - many of them was directly to main branch
|
||||||
|
|
||||||
|
- for example iterative CI/CD setup
|
||||||
|
|
||||||
|
done
|
||||||
|
create src in 7project
|
||||||
|
make the chart vertical
|
||||||
|
urls as hyperlinks text
|
||||||
|
frontned npm run dev as codeblock
|
||||||
|
describe folder structure in readme in 7project
|
||||||
|
add comment column to checklist
|
||||||
|
readme in src folder with folder structure description
|
||||||
|
readme in src/tofu
|
||||||
|
readme in src/charts
|
||||||
|
add link to report for app
|
||||||
|
write few lines in Build intructrions, deployment instructions like in testing
|
||||||
|
|
||||||
|
|
||||||
|
add other services in cluster in report architecture overview
|
||||||
|
|
||||||
|
debug commands - kubectl logs -f podname, mention grafana
|
||||||
Reference in New Issue
Block a user