From b5290119e927114408c02ffee9128607eee1b52a Mon Sep 17 00:00:00 2001 From: ribardej Date: Fri, 14 Nov 2025 17:56:08 +0100 Subject: [PATCH] feat(docs): report.md update --- 7project/checklist.md | 116 +++++++++++++++++++++--------------------- 7project/report.md | 54 ++++++++++++++++++++ 2 files changed, 112 insertions(+), 58 deletions(-) diff --git a/7project/checklist.md b/7project/checklist.md index 803c445..0178d3c 100644 --- a/7project/checklist.md +++ b/7project/checklist.md @@ -7,64 +7,64 @@ 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** | **Comments** | -|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------| | -| **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** | **Comments** | +|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|---------------| +| **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** | | ## Grading Scale diff --git a/7project/report.md b/7project/report.md index 83cf28d..900acf5 100644 --- a/7project/report.md +++ b/7project/report.md @@ -48,6 +48,60 @@ flowchart TB client <-- HTTP request/response --> n2 ``` +### 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 +``` + The workflow works in the following way: - Client connects to the frontend. After login, frontend automatically fetches the stored transactions from