Skip to content

Doc / Grading Table Tracker #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stark-cybertech wants to merge 2 commits into from
Closed

Doc / Grading Table Tracker #69

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b51d30d
docs: upload grading table for progress tracking
stark-cybertech Jul 4, 2025
f1e105a
docs: add update status for enrico
EnricoBausenhart Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions docs/grading_table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
## 1. 🧩 Functional Application (20 Points)

| Criteria | Points | Status | Responsible | Comment |
| -------------------------------------------------------------------------- | ------ | ------ | ----------- | -------------------------------------------------------------------------------------------------------------------------- |
| End-to-end functionality between all components (client, server, database) | 6 | 60% | All | |
| Smooth and usable user interface | 4 | 70% | Enrico | Mock data needs to be removed once backend is fully ready. Dashboard and Profile page not pushed yet, but already finished |
| REST API is clearly defined and matches functional needs | 4 | 90% | James | Will need some expansion for Invite/RSVP by @Anastasiia |
| Server Side has at least 3 microservices | 4 | 100% | All | |
| Application topic is appropriately chosen and fits project objectives | 2 | 100% | All | |

## 2. 🤖 GenAI Integration (10 Points)

| Criteria | Points | Status | Responsible | Comment |
| --------------------------------------------------------------------- | ------ | ------ | ----------- | ------- |
| GenAI module is well-embedded and fulfills a real user-facing purpose | 4 | %? | Anastasiia | |
| Connects to cloud/local LLM | 4 | %? | Anastasiia | |
| Modularity of the GenAI logic as a microservice | 2 | %? | Anastasiia | |

---

## 3. 🐳 Containerization & Local Setup (10 Points)

| Criteria | Points | Status | Responsible | Comment |
| --------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ----------- | --------------------------- |
| Each component is containerized and runnable in isolation | 6 | 100% | All | |
| docker-compose.yml enables local development and testing with minimal effort and provides sane defaults (no complex env setup required) | 4 | 90% | James | Requires testing at the end |

---

## 4. 🔁 CI/CD & Deployment (20 Points)

| Criteria | Points | Status | Responsible | Comment |
| ----------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| CI pipeline with build, test, and Docker image generation via GitHub Actions | 8 | 80% | James (6):<br>- Build,<br>- Publish<br>- Unit Testing<br><br>Open (2):<br>- Integration Testing<br>(Anastasiia?) | Missing integration testing<br> |
| CD pipeline set up to automatically deploy to Kubernetes on main merge | 6 | 90%\* | Anastasiia | Needs work to match current implementation |
| Deployment works on our infrastructure or Cloud, alternative Kubernetes environments (e.g., Minikube, TUM infra, Azure) | 6 | 90% | Enrico (AWS) | AWS Compose file needs to be adapted to the final implementation |

---

## 5. 📊 Monitoring & Observability (10 Points)

| Criteria | Points | Status | Responsible | Comment |
| ------------------------------------------------------- | ------ | ------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Prometheus integrated and collecting meaningful metrics | 4 | 50% | Enrico | Prometheus and Grafana are integrated in the Helm deployment; connection to the microservices will be done once they expose the metrics endpoint |
| Grafana dashboards for system behavior visualization | 4 | 0% | Enrico | Will be discussed in team meeting (07-07) |
| At least one alert rule set up | 2 | 0% | Enrico | Will be discussed in team meeting (07-07) |

---

## 6. 🧪 Testing & Structured Engineering Process (20 Points)

| Criteria | Points | Status | Responsible | Comment |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| Test cases implemented for server/client and GenAI logic | 6 | 30% | Unit: <br><br>James (2):<br>- User<br>- Matching<br><br>Anastasiia (2)<br>- Gateway<br>- RSVP<br>- GenAI<br><br>Integration:<br>- Open (2)<br>- (Anastasiia?) | |
| Evidence of software engineering process: documented requirements, architecture models, such as top-level architecture, use case diagramm and analysis object model. | 10 | - | All | Requires update at the end |
| Tests run automatically in CI and cover key functionality | 4 | 50% | James | Units Run automatically.<br><br>Work needed on Integration |

---

## 7. 📚 Documentation & Weekly Reporting (10 Points)

| Criteria | Points | Status | Responsible | Comment |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------ | --------------------- | -------------------------------------------- |
| [README.md](http://README.md) or Wiki includes setup instructions, architecture overview, usage guide, and a clear mapping of student responsibilities | 2 | %? | Open<br>(James?) | Needs update at end<br><br>Upload this table |
| Documentation of CI/CD setup, and GenAI usage included | 2 | %? | Open<br>(James)? | Needs update at end |
| Deployment and local setup instructions are clear, reproducible, and platform-specific (≤3 commands for local setup, with sane defaults) | 2 | %? | Open<br>(Anastasiia?) | Needs update at end |
| Subsystems have documented interfaces (API-driven deployment, e.g. Swagger/OpenAPI) | 2 | 100% | James | May need update |
| Monitoring instructions included in the documentation and exported as files | 2 | %? | Enrico | Unsure what this means |

---

## 8. 🎤 Final Presentation (Pass/Fail)

| Criteria | Points | Status |
| ----------------------------------------------------------------------------------------- | --------- | ------ |
| All students present their own subsystem | Pass/Fail | Open |
| Live demo of application and DevOps setup | Pass/Fail | Open |
| Team reflects on what worked well, what didn’t, and answers follow-up technical questions | Pass/Fail | Open |

---

## 🏅 Bonus Points (up to +5)

| Criteria | Points | Status | Responsible | Comment |
| ---------------------------------------------------------------------------- | ------ | ------ | ----------- | -------------------------------------------------------------- |
| Advanced Kubernetes use (e.g., self-healing, custom operators, auto-scaling) | +1 | ? | Anastasiia? | How hard is this to implement |
| Full RAG pipeline implementation (with vector DB like Weaviate) | +1 | ? | Anastasiia? | Part of GenAI.<br><br>Is this even applicable to our use-case? |
| Real-world-grade observability (e.g., log aggregation, tracing) | +1 | ? | Enrico? | How hard is this to implement |
| Beautiful, original UI or impactful project topic | +1 | %? | Enrico | This is pretty much done no? |

## Total Points

| Responsible | Current | Including Open |
| ----------- | ------- | -------------- |
| All | 28 | 28 |
| Enrico | 22 | 24 |
| James | 22 | 26 |
| Anastasiia | 18 | 26 |
| Open | 10 | 0 |
| Extra | 4 | 0 |