lukas/uis-cloud-computing
1
0
Fork 0
mirror of https://github.com/dat515-2025/Group-8.git synced 2026-03-22 06:57:47 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Compare commits

base: lukas:515106b238bc032d5f7d5dcae931b5cb7ee2a281
Branches Tags
lukas:main lukas:merge/core_simplificcation lukas:test_arm_build lukas:51-refactor-project-structure lukas:merge/update_workers lukas:merge/email_sender lukas:merge/prometheus_custom_metrics lukas:add_more_tests lukas:merge/prometheus_metrics lukas:merge/csas_scraping lukas:30-create-tests-and-set-up-a-github-pipeline lukas:merge/fix_react_oauth lukas:merge/frontend_basics lukas:merge/deployment_envs lukas:20-create-a-controller-layer-on-backend-side lukas:merge/database_backups lukas:merge/oauth lukas:merge/basic_database_structure lukas:11-update-deployment lukas:merge/cloudflare-deploy lukas:merge/pr_deploy_test lukas:merge/background-worker lukas:merge/refactor_migrations
..
compare: lukas:main
Branches Tags
lukas:main lukas:merge/core_simplificcation lukas:test_arm_build lukas:51-refactor-project-structure lukas:merge/update_workers lukas:merge/email_sender lukas:merge/prometheus_custom_metrics lukas:add_more_tests lukas:merge/prometheus_metrics lukas:merge/csas_scraping lukas:30-create-tests-and-set-up-a-github-pipeline lukas:merge/fix_react_oauth lukas:merge/frontend_basics lukas:merge/deployment_envs lukas:20-create-a-controller-layer-on-backend-side lukas:merge/database_backups lukas:merge/oauth lukas:merge/basic_database_structure lukas:11-update-deployment lukas:merge/cloudflare-deploy lukas:merge/pr_deploy_test lukas:merge/background-worker lukas:merge/refactor_migrations

9 Commits
515106b238 ... main

Author SHA1 Message Date
ribardej
16f660ea5b feat(docs): finalized checklist.md 2025-11-16 21:07:16 +01:00
Lukáš Trkan
7a0d7dc4af update report 2025-11-16 17:30:51 +01:00
Lukáš Trkan
fabdff3bef update checklist 2025-11-16 17:27:13 +01:00
Lukáš Trkan
1c1130b9b0 update checklist 2025-11-16 17:21:45 +01:00
Lukáš Trkan
7d7698450d feat(deployment): Optimize Dockerfile 2025-11-16 17:07:32 +01:00
ribardej
db9092b78f feat(docs): checklist.md and report.md update 2025-11-15 23:48:29 +01:00
Lukáš Trkan
3557b3ea13 updated Dockerfile 2025-11-15 18:23:09 +01:00
Lukáš Trkan
4a1a9f03a1 Merge remote-tracking branch 'origin/main' 2025-11-15 13:55:51 +01:00
Lukáš Trkan
b1be15f559 updated docs 2025-11-15 13:55:41 +01:00
4 changed files with 234 additions and 151 deletions
Expand all files Collapse all files

119
7project/checklist.md
View File

@@ -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 |

193
7project/report.md
View File

@@ -47,6 +47,7 @@ flowchart TB
svc <-- HTTP request/response --> api[("UniRate API")] svc <-- HTTP request/response --> api[("UniRate API")]
client <-- HTTP request/response --> n2 client <-- HTTP request/response --> n2
``` ```
The workflow works in the following way: The workflow works in the following way:
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from - Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
@@ -59,54 +60,54 @@ The workflow works in the following way:
```mermaid ```mermaid
classDiagram classDiagram
direction BT direction BT
class alembic_version { class alembic_version {
varchar(32) version_num varchar(32) version_num
} }
class categories { class categories {
varchar(100) name varchar(100) name
varchar(255) description varchar(255) description
char(36) user_id char(36) user_id
int(11) id int(11) id
} }
class category_transaction { class category_transaction {
int(11) category_id int(11) category_id
int(11) transaction_id int(11) transaction_id
} }
class oauth_account { class oauth_account {
char(36) user_id char(36) user_id
varchar(100) oauth_name varchar(100) oauth_name
varchar(4096) access_token varchar(4096) access_token
int(11) expires_at int(11) expires_at
varchar(1024) refresh_token varchar(1024) refresh_token
varchar(320) account_id varchar(320) account_id
varchar(320) account_email varchar(320) account_email
char(36) id char(36) id
} }
class transaction { class transaction {
blob amount blob amount
blob description blob description
char(36) user_id char(36) user_id
date date date date
int(11) id int(11) id
} }
class user { class user {
varchar(100) first_name varchar(100) first_name
varchar(100) last_name varchar(100) last_name
varchar(320) email varchar(320) email
varchar(1024) hashed_password varchar(1024) hashed_password
tinyint(1) is_active tinyint(1) is_active
tinyint(1) is_superuser tinyint(1) is_superuser
tinyint(1) is_verified tinyint(1) is_verified
longtext config longtext config
char(36) id char(36) id
} }
categories --> user : user_id -> id categories --> user: user_id -> id
category_transaction --> categories : category_id -> id category_transaction --> categories: category_id -> id
category_transaction --> transaction : transaction_id -> id category_transaction --> transaction: transaction_id -> id
oauth_account --> user : user_id -> id oauth_account --> user: user_id -> id
transaction --> user : user_id -> id transaction --> user: user_id -> id
``` ```
### Features ### Features
@@ -263,8 +264,9 @@ 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 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. or by setting them in run configuration in your IDE.
```bash ```bash
cd backend cd backend
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000 uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
@@ -574,20 +576,19 @@ 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
### Common Issues ### Common Issues
#### Issue 1: Unable to apply Cloudflare terraform module #### Issue 1: Unable to apply Cloudflare terraform module
@@ -613,26 +614,32 @@ by either hitting docker hub rate limits or by docker hub being down.
### Debug Commands ### Debug Commands
Get a detailed description of the Deployment: Get a detailed description of the Deployment:
```bash ```bash
kubectl describe deployment finance-tracker -n prod kubectl describe deployment finance-tracker -n prod
``` ```
Get a list of pods in the Deployment: Get a list of pods in the Deployment:
```bash ```bash
kubectl get pods -n prod 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): 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 ```bash
kubectl logs <pod-name> -n prod --previous kubectl logs <pod-name> -n prod --previous
``` ```
See the service description: See the service description:
```bash ```bash
kubectl describe service finance-tracker -n prod kubectl describe service finance-tracker -n prod
``` ```
Connect to the pod and run a bash shell: Connect to the pod and run a bash shell:
```bash ```bash
kubectl exec -it <pod-name> -n prod -- /bin/bash kubectl exec -it <pod-name> -n prod -- /bin/bash
``` ```
@@ -645,34 +652,30 @@ kubectl exec -it <pod-name> -n prod -- /bin/bash
> 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 | 40 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 | 14 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` |
@@ -685,8 +688,9 @@ kubectl exec -it <pod-name> -n prod -- /bin/bash
| 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
@@ -708,8 +712,7 @@ kubectl exec -it <pod-name> -n prod -- /bin/bash
| 25.9. to 14.11. | Documentation | 8 | Documenting the dev process | multiple `feat(docs): report.md update` | | 25.9. to 14.11. | Documentation | 8 | Documenting the dev process | multiple `feat(docs): report.md update` |
| **Total** | | **87** | | | | **Total** | | **87** | | |
### Group Total: 194 hours
### Group Total: 192 hours
--- ---
@@ -718,10 +721,13 @@ kubectl exec -it <pod-name> -n prod -- /bin/bash
### What We Learned ### What We Learned
#### Technical #### Technical
- We learned how to use AI to help us with our project. - 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 use Copilot for PR reviews.
- We learned how to troubleshoot issues with our project in different areas. - We learned how to troubleshoot issues with our project in different areas.
#### Collaboration #### Collaboration
- Weekly meetings with the TA were great for syncing up on progress, discussing issues, planning future work. - 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. - Using GitHub issues and pull requests was very helpful for keeping track of progress.
@@ -738,6 +744,7 @@ 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 #### 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. 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. In the end, we were able to implement all necessary features.
@@ -755,7 +762,8 @@ Using private container registry would allow us to include environment variables
This would simplify deployment and CI/CD setup. This would simplify deployment and CI/CD setup.
#### Start sooner #### Start sooner
The weekly meetings helped us to start planning the project earlier and avoid spending too much time on details,
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. 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?]
@@ -775,18 +783,23 @@ used not only by myself.
#### [Dejan] #### [Dejan]
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. Since I do not have a job and I am more theoretically oriented student (I am more into math, algorithms, cryptography),
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. 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. 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). 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). It was challenging to wrap my head around the project structure and how everything was connected (And I still think I
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. 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

12
7project/src/backend/Dockerfile
View File

@@ -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"]

61
todo.md Normal file
View 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