From db9092b78fd362370ac558df248babebe9e7c7d7 Mon Sep 17 00:00:00 2001 From: ribardej Date: Sat, 15 Nov 2025 23:48:29 +0100 Subject: [PATCH] feat(docs): checklist.md and report.md update --- 7project/checklist.md | 118 +++++++++++++++++++++--------------------- 7project/report.md | 16 +++--- 2 files changed, 67 insertions(+), 67 deletions(-) diff --git a/7project/checklist.md b/7project/checklist.md index 5dea47b..6abc3ae 100644 --- a/7project/checklist.md +++ b/7project/checklist.md @@ -7,65 +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** | **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** | **Comment** | +|:---------------------------------|:----------------------------------------|:---------------|:-----------|:----------------------------------------------------------------------------------------------------| +| **Core Deliverables (Required)** | | | | | +| Codebase & Organization | Well-organized project structure | 5 | 5 | Project is well-organized | +| | 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 | +| Documentation | Comprehensive reproducibility report | 10 | 8 | Our report is precise | +| | 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. | +| 30 | 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 | +| 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 | The app should be robust enough for normal use (TODO Lukasi kdyztak oprav pls) | +| 24 | User-friendly interface | 5 | 4 | Could always be better | +| Backend & Architecture | Stateless web server | 5 | 0 | Our server is stateful | +| | Stateful application | 10 | 10 | Our server is stateful | +| | Database integration | 10 | 10 | Yes, db is integrated | +| | API design | 5 | 5 | Backend APIs are implemented with public Swagger docs | +| 28 | Microservices architecture | 10 | 3 | Well not really but we have the app and the worker services divided (TODO Lukasi kdyztak oprav pls) | +| Cloud Integration | Basic cloud deployment | 10 | 10 | Yes (In private cluster) | +| | Cloud APIs usage | 10 | 0 | Not Applicable (TODO Lukasi kdyztak oprav pls) | +| | Serverless components | 10 | 0 | No (TODO Lukasi kdyztak oprav pls) | +| 10 | Advanced cloud services | 5 | 0 | Not Applicable (TODO Lukasi kdyztak oprav pls) | +| **DevOps & Deployment** | | | | | +| Containerization | Basic Dockerfile | 5 | 5 | Yes | +| | Optimized Dockerfile | 5 | 0 | Not really (TODO Lukasi kdyztak oprav pls) | +| | Docker Compose | 5 | 5 | dev only | +| 15 | Persistent storage | 5 | 5 | Yes | +| Deployment & Scaling | Manual deployment | 5 | 5 | Yes, possible | +| | Automated deployment | 5 | 5 | Yes, withGithub runners | +| | Multiple replicas | 5 | 5 | Yes (4) | +| 25 | Kubernetes deployment | 10 | 10 | Yes | +| **Quality Assurance** | | | | | +| Testing | Unit tests | 5 | 2 | Basic coverage | +| | Integration tests | 5 | 5 | Yes | +| | End-to-end tests | 5 | 5 | Yes | +| 12 | Performance testing | 5 | 0 | No | +| Monitoring & Operations | Health checks | 5 | 5 | Yes | +| | Logging | 5 | 2 | only to terminal add logstash | +| | Metrics/Monitoring | 2 | 2 | Yes | +| 12 | Custom Metrics for your project | 3 | 3 | Prometheus, Grafana | +| 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 | 3 | Delegating emails and scraping to workers | +| 7 | Exceptional user experience | 5 | 0 | | +| **Total** | | **255** | **214** | | ## Grading Scale - **Minimum Required: 100 points** diff --git a/7project/report.md b/7project/report.md index 5f96798..f1af04b 100644 --- a/7project/report.md +++ b/7project/report.md @@ -575,16 +575,16 @@ npm run dev in 7project/src/frontend ## 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 @@ -799,5 +799,5 @@ more efficiently. --- -**Report Completion Date**: [Date] -**Last Updated**: 13.11.2025 \ No newline at end of file +**Report Completion Date**: 15.11.2025 +**Last Updated**: 15.11.2025 \ No newline at end of file