Skip to content

Commit 6dbd8af

Browse files
stark-cybertechstark-cybertech
committed
docs: Add grading table
1 parent 65aab41 commit 6dbd8af

File tree

2 files changed

+89
-0
lines changed

2 files changed

+89
-0
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ This model contains information about Meet@Mensa's use-cases.
109109
There's much more to see, check it out!
110110
- [API Spec](https://aet-devops25.github.io/team-devoops/api.html)
111111
- [Problem Statement](docs/problem_statement.md)
112+
- [Grading Table & Student Responsabilities](docs/grading_table.md)
112113
- [Grafana Dashboards]() # TODO Add
113114
- [CI/CD Pipeline]() # TODO Add
114115
- [Matching Algorithm](server/matching/README.md)

‎docs/grading_table.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## 1. 🧩 Functional Application (20 Points)
2+
3+
| Criteria | Points | Status | Responsible | Comment |
4+
| -------------------------------------------------------------------------- | ------ | ------ | ----------- | ------- |
5+
| End-to-end functionality between all components (client, server, database) | 6 | 100% | All | |
6+
| Smooth and usable user interface | 4 | 100% | Enrico | |
7+
| REST API is clearly defined and matches functional needs | 4 | 100% | James | |
8+
| Server Side has at least 3 microservices | 4 | 100% | All | |
9+
| Application topic is appropriately chosen and fits project objectives | 2 | 100% | All | |
10+
## 2. 🤖 GenAI Integration (10 Points)
11+
12+
| Criteria | Points | Status | Responsible | Comment |
13+
| --------------------------------------------------------------------- | ------ | ------ | ----------- | ------- |
14+
| GenAI module is well-embedded and fulfills a real user-facing purpose | 4 | 100% | Anastasiia | |
15+
| Connects to cloud/local LLM | 4 | 100% | Anastasiia | |
16+
| Modularity of the GenAI logic as a microservice | 2 | 100% | Anastasiia | |
17+
18+
---
19+
20+
## 3. 🐳 Containerization & Local Setup (10 Points)
21+
22+
| Criteria | Points | Status | Responsible | Comment |
23+
| --------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ----------- | ------- |
24+
| Each component is containerized and runnable in isolation | 6 | 100% | All | |
25+
| docker-compose.yml enables local development and testing with minimal effort and provides sane defaults (no complex env setup required) | 4 | 100% | James | |
26+
27+
---
28+
29+
## 4. 🔁 CI/CD & Deployment (20 Points)
30+
31+
| Criteria | Points | Status | Responsible | Comment |
32+
| ----------------------------------------------------------------------------------------------------------------------- | ------ | ------ | -------------------------------------------------- | ------- |
33+
| CI pipeline with build, test, and Docker image generation via GitHub Actions | 8 | 100% | James (4):<br><br>Anastasiia (2)<br><br>Enrico (2) | <br> |
34+
| CD pipeline set up to automatically deploy to Kubernetes on main merge | 6 | 100% | Anastasiia | |
35+
| Deployment works on our infrastructure or Cloud, alternative Kubernetes environments (e.g., Minikube, TUM infra, Azure) | 6 | 100% | Enrico (AWS) | |
36+
37+
---
38+
39+
## 5. 📊 Monitoring & Observability (10 Points)
40+
41+
| Criteria | Points | Status | Responsible | Comment |
42+
| ------------------------------------------------------- | ------ | ------ | ----------- | ------------------------------------------------------------------ |
43+
| Prometheus integrated and collecting meaningful metrics | 4 | 80%* | Enrico | Unable to deploy to Rancher due to permissions issues with Grafana |
44+
| Grafana dashboards for system behavior visualization | 4 | 100% | Enrico | |
45+
| At least one alert rule set up | 2 | 100% | Enrico | |
46+
47+
---
48+
49+
## 6. 🧪 Testing & Structured Engineering Process (20 Points)
50+
51+
| Criteria | Points | Status | Responsible | Comment |
52+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | -------------------------------------------------------------------------------------------------- | ------- |
53+
| Test cases implemented for server/client and GenAI logic | 6 | 100% | James (2):<br>- User<br>- Matching<br><br>Anastasiia (2):<br>- GenAI<br><br>Enrico(2):<br>- Client | |
54+
| Evidence of software engineering process: documented requirements, architecture models, such as top-level architecture, use case diagramm and analysis object model. | 10 | 100% | All | |
55+
| Tests run automatically in CI and cover key functionality | 4 | 100% | James | |
56+
57+
---
58+
59+
## 7. 📚 Documentation & Weekly Reporting (10 Points)
60+
61+
| Criteria | Points | Status | Responsible | Comment |
62+
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------ | ----------- | ------- |
63+
| [README.md](http://README.md) or Wiki includes setup instructions, architecture overview, usage guide, and a clear mapping of student responsibilities | 2 | 100% | James | |
64+
| Documentation of CI/CD setup, and GenAI usage included | 2 | 100% | Anastassia | |
65+
| Deployment and local setup instructions are clear, reproducible, and platform-specific (≤3 commands for local setup, with sane defaults) | 2 | 100% | Anastasiia | |
66+
| Subsystems have documented interfaces (API-driven deployment, e.g. Swagger/OpenAPI) | 2 | 100% | James | |
67+
| Monitoring instructions included in the documentation and exported as files | 2 | 100% | Enrico | |
68+
69+
---
70+
71+
## 8. 🎤 Final Presentation (Pass/Fail)
72+
73+
| Criteria | Points | Status |
74+
| ----------------------------------------------------------------------------------------- | --------- | ------ |
75+
| All students present their own subsystem | Pass/Fail | Open |
76+
| Live demo of application and DevOps setup | Pass/Fail | Open |
77+
| Team reflects on what worked well, what didn’t, and answers follow-up technical questions | Pass/Fail | Open |
78+
79+
---
80+
81+
## 🏅 Bonus Points (up to +5)
82+
83+
| Criteria | Points | Status | Responsible | Comment |
84+
| ---------------------------------------------------------------------------- | ------ | ------ | ----------- | -------------------------------------------------------------- |
85+
| Advanced Kubernetes use (e.g., self-healing, custom operators, auto-scaling) | +1 | 0% | | |
86+
| Full RAG pipeline implementation (with vector DB like Weaviate) | +1 | 0% | | Not applicable |
87+
| Real-world-grade observability (e.g., log aggregation, tracing) | +1 | 50% | Enrico | Limited by grafana permission issues |
88+
| Beautiful, original UI or impactful project topic | +1 | 100% | Enrico | In our opinion |

0 commit comments

Comments
 (0)