Developer Manuals

• Architecture
  • Architecture model
  • Domain model
  • Architecture
  • Repository structure
    • Challenges and solutions of having different repositories
    • Shared code
• Authentication
  • Keycloak
• Gamification
  • Hexad Player-Type Questionnaire (12 Questions)
    • Questions
    • Scoring Method
  • Gamification
  • Scoring System - Rewards & Skill levels
    • Two System Approach
    • The reward system
    • The skill level system
  • Suggestions
    • What are suggestions for?
    • How do they work?
    • Possible implementation
    • Possible extensions for the future
  • Flashcard concepts
    • A single flashcard
    • A flashcard set
  • Concept for a Non-Linear Curriculum
    • Alternative Concept
  • Quizzes
    • The general interface
  • Spaced Repetition
    • Exact calculation:
  • User progress data
    • Overview
    • Purpose of progress data
    • Location of progress data
    • Structure of progress data
    • Content-specific progress data
    • Implementation details
• Project Management
  • Checklists
    • Did I forget?
    • Pipeline
  • EnPro SS25
    • Definition of Done
    • Game Team
    • AI Team
    • Project Manager
• Backend
  • Dapr
    • PubSub Messaging Using Dapr
    • Dapr Service Topic Overview
  • AI Tutor
    • AI Tutor Chat/Questions
    • AI Tutor Hints
  • Send Notifications from your service
    • 1) Dependencies (common + optional SDK)
    • 2) Payload shape: NotificationEvent
    • 3) Publish
    • 4) Quick verification
    • Cheatsheet
  • Ports
    • Currently used Ports
  • Sorting, Filtering, and Pagination
    • GraphQL Schema
    • Implementation
  • List of libraries for all the services.
  • Authentication, Authorization & Accessing Current User Data From Services
    • Authentication
    • Authorization
    • Accessing User Data From Services
  • Authorization Concept
    • General Assumptions, Conditions, and Decisions Regarding the Concept
    • User Roles
    • Basic Components
    • Authorization Concept
    • Handling GraphQL requests where the user only has permissions for some subitems
    • Speeding up nested GraphQL queries
  • Coding Guidelines
    • Package structure
    • Style Guide
    • How To…
  • Deletion Concept
    • Data Dependencies
    • Deletion events
    • Dapr PubSub
  • Get Started
    • Prerequisites
  • Setting Up the Dev Environment
    • Cloning
    • Deployment
    • Debugging/ Running Selected Services Locally
  • Some Hints/Common Issues
    • docprocai Service Taking Forever to Build
    • “database <service_name> does not exist” FATAL Log Messages in database Container
    • Observing/ Testing the GraphQL API
    • I adjusted the GraphQL API of a Service locally run, what now?
    • docprocai Service failing to Start
    • Error Unsupported class file major version 64 when compiling
  • Unified GraphQL API
    • GraphQL Mesh Concept
    • Further Information/Guides For GraphQL Mesh
  • Automatically generate graphQL API docs
  • Adding a new service
  • Static code analysis
    • Tool-based code analysis
    • How to use sonarqube
  • Test strategy overview
    • General
    • Backend
    • Frontend
  • Backend testing
    • Unit testing
    • Integration/API testing
• Frontend
  • AI Tutor Documentation
    • Table of Contents
    • Project Structure
    • Component Overview
    • API Integration
    • Customization & Extension Points
    • Styling
    • Internationalization
    • Known Issues / TODOs
  • Get Started
    • Technologies used
  • Setup
    • IDE Setup
  • Project Structure
    • Overview
  • Frontend testing
• Deployment
  • Deploy a new Service
    • Structure
    • Deployment resource
    • Helm release resource
    • Password resource
    • Environmental Variables
    • Health, Liveness & Readiness probe
  • MEITREX Infrastructure
    • Overview
    • Deployment Approach
    • Repository Structure
  • Pod Probing
    • Enabling Probing for a service
    • Probing for Dapr Sidecar
  • Setup Guide
    • Step 6 Setup keycloak realm
    • Step 6 Setup webhook for AI Service
• ReadTheDocs
  • How to add a new folder to ReadTheDocs
  • How to setup ReadTheDocs locally
  • How to test the ReadTheDocs pages locally
• Scalability Testing
  • Scalability Testing
    • Prerequisites
    • Test setup
    • Writing and running tests
• Services
  • Assignment Service
    • Assignment Types
    • Tracking a user’s progress
    • GitHub Classroom Integration
  • Content service
    • Data structures
    • Content types
    • Tracking of user progress on content
    • Content Suggestions
    • Management of Items and Skills
  • Course service
  • Flashcard service
    • Tracking a user’s progress
  • Course service
  • Gateway
    • Usage
    • Adding More Microservices to the Gateway
  • Media service
    • MinIO content Data
    • Tracking a user’s progress
  • Notification service
    • Data structures
    • Notification types
    • Tracking of delivery and read status
    • Notification subscriptions
    • Management of preferences and recipients
  • Quiz service
    • Quiz types
    • Tracking a user’s progress
  • Reward service
    • Score calculation and information gathering
  • Skill level service
    • Score calculation and information gathering
  • User service
    • 1. GraphQL interface for user metadata
    • 2. OAuth2 Access Token Management
    • GitHub OAuth Configuration
• Settings
  • Settings
• Uml Assignment
  • Introduction
  • Requirements
  • System Design and Architecture
    • Domain Model
    • HyLiMo Integration
    • Automated UML Assessment
    • Evaluation
    • Functionalities
    • Future Improvements