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

feat(docs): checklist.md and report.md update

Browse Source
This commit is contained in:
ribardej
2025-11-15 23:48:29 +01:00
parent 3557b3ea13
commit db9092b78f
2 changed files with 67 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
7project/checklist.md
View File

@@ -7,65 +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 |
| | 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 |
| Documentation | Comprehensive reproducibility report | 10 | 4-5 | | | Documentation | Comprehensive reproducibility report | 10 | 8 | Our report is precise |
| | 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 | | | 30 | 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 |
| 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 | The app should be robust enough for normal use (TODO Lukasi kdyztak oprav pls) |
| 16 | User-friendly interface | 5 | 4 | | | 24 | User-friendly interface | 5 | 4 | Could always be better |
| Backend & Architecture | Stateless web server | 5 | 5 | | | Backend & Architecture | Stateless web server | 5 | 0 | Our server is stateful |
| | Stateful application | 10 | ? WHAT DOES THIS MEAN | | | | Stateful application | 10 | 10 | Our server is stateful |
| | Database integration | 10 | 10 | | | | Database integration | 10 | 10 | Yes, db is integrated |
| | API design | 5 | 5 | | | | API design | 5 | 5 | Backend APIs are implemented with public Swagger docs |
| 20 | Microservices architecture | 10 | 0 | | | 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 | | | Cloud Integration | Basic cloud deployment | 10 | 10 | Yes (In private cluster) |
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN | | | | Cloud APIs usage | 10 | 0 | Not Applicable (TODO Lukasi kdyztak oprav pls) |
| | Serverless components | 10 | 0 | | | | Serverless components | 10 | 0 | No (TODO Lukasi kdyztak oprav pls) |
| 10 | Advanced cloud services | 5 | 0 | | | 10 | Advanced cloud services | 5 | 0 | Not Applicable (TODO Lukasi kdyztak oprav pls) |
| **DevOps & Deployment** | | | | | | **DevOps & Deployment** | | | | |
| Containerization | Basic Dockerfile | 5 | 5 | | | Containerization | Basic Dockerfile | 5 | 5 | Yes |
| | Optimized Dockerfile | 5 | 0 | | | | Optimized Dockerfile | 5 | 0 | Not really (TODO Lukasi kdyztak oprav pls) |
| | Docker Compose | 5 | 5 - dev only | | | | Docker Compose | 5 | 5 | dev only |
| 15 | Persistent storage | 5 | 5 | | | 15 | Persistent storage | 5 | 5 | Yes |
| Deployment & Scaling | Manual deployment | 5 | 5 | | | Deployment & Scaling | Manual deployment | 5 | 5 | Yes, possible |
| | Automated deployment | 5 | 5 | | | | Automated deployment | 5 | 5 | Yes, withGithub runners |
| | Multiple replicas | 5 | 5 | | | | Multiple replicas | 5 | 5 | Yes (4) |
| 20 | Kubernetes deployment | 10 | 10 | | | 25 | Kubernetes deployment | 10 | 10 | Yes |
| **Quality Assurance** | | | | | | **Quality Assurance** | | | | |
| Testing | Unit tests | 5 | 2 | | | Testing | Unit tests | 5 | 2 | Basic coverage |
| | 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 | | | 12 | 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 | 2 | only to terminal add logstash |
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint | | | | Metrics/Monitoring | 2 | 2 | Yes |
| Security | HTTPS/TLS | 5 | 5 | | | 12 | Custom Metrics for your project | 3 | 3 | Prometheus, Grafana |
| | 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 | 3 | Delegating emails and scraping to workers |
| **Total** | | **255** | **153** | | | 7 | Exceptional user experience | 5 | 0 | |
| **Total** | | **255** | **214** | |
## Grading Scale ## Grading Scale
- **Minimum Required: 100 points** - **Minimum Required: 100 points**

16
7project/report.md
View File

@@ -575,16 +575,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
@@ -799,5 +799,5 @@ more efficiently.
--- ---
**Report Completion Date**: [Date] **Report Completion Date**: 15.11.2025
**Last Updated**: 13.11.2025 **Last Updated**: 15.11.2025