lasserh/DeutschLernen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
DeutschLernen/docs
History
Lasse Rune Hansen 6693165f83 feat(backend/story-integration): Phase 2 - Backend Services 
Implement story integration backend services:
- Create StoryService (Application/Services/StoryService.cs) with full CRUD operations
- Create StoryGenerationService (Application/Services/StoryGenerationService.cs) for AI-powered story generation
  - Uses IMistralService for text generation
  - Uses ITtsService for audio generation
  - Splits stories into segments per lesson
- Create StoryUnlockService (Application/Services/StoryUnlockService.cs) for progress management
  - Handles lesson completion → story segment unlocking
- Create StoryController (Presentation/Controllers/StoryController.cs) with 12 endpoints:
  - GET /api/story/levels - list levels with stories
  - GET /api/story/levels/{levelId}/segments - get segments for level
  - GET /api/story/segments/{id} - get specific segment
  - POST /api/story/segments - create segment (Admin)
  - PUT /api/story/segments/{id} - update segment (Admin)
  - DELETE /api/story/segments/{id} - delete segment (Admin)
  - POST /api/story/levels/{levelId}/generate - generate story with AI (Admin)
  - POST /api/story/segments/{segmentId}/audio - generate audio (Admin)
  - GET /api/story/levels/{levelId}/progress - get user progress
  - POST /api/story/segments/{segmentId}/complete - mark as completed
  - GET /api/story/levels/{levelId}/next - get next segment
  - GET /api/story/segments/{segmentId}/unlocked - check if unlocked
  - GET /api/story/segments/{segmentId}/audio - get audio URL
  - GET /api/story/levels/{levelId}/lessons-with-stories - get lessons with story status
- Register all services in Program.cs DI container
- Update feature document to reflect Phase 2 completion

Next: Phase 3 - AI Integration (unit tests for services)

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-06-13 13:37:16 +02:00
..
architecture Add complete solution: documentation, frontend, and project files 2026-05-31 18:20:53 +02:00
database Add complete solution: documentation, frontend, and project files 2026-05-31 18:20:53 +02:00
development Add complete solution: documentation, frontend, and project files 2026-05-31 18:20:53 +02:00
features feat(backend/story-integration): Phase 2 - Backend Services 2026-06-13 13:37:16 +02:00
README.md Add complete solution: documentation, frontend, and project files 2026-05-31 18:20:53 +02:00
ROADMAP.md feat(backend/ai-services): Complete AI Services Phase 0-4 implementation 2026-06-13 10:09:19 +02:00

README.md

DeutschLernen Documentation

Welcome to the documentation for the DeutschLernen solution. This directory contains all project documentation organized by category.

📚 Documentation Structure

docs/
├── README.md                  # This file - Table of Contents
│
├── architecture/              # System architecture & design
│   ├── application-plan.md    # High-level application plan and vision
│   ├── backend-structure.md   # Backend architecture and component structure
│   └── frontend-structure.md  # Frontend architecture and component structure
│
├── database/                  # Database-related documentation
│   └── initial-database-schema.sql  # Initial SQL schema for the database
│
└── development/              # Development guides & setup
    └── how-to-run-vibe.md      # Guide for running Vibe CLI in this project

📖 Documentation Categories

Architecture 🏗️

File Description Last Updated
application-plan.md Overall application vision, features, and roadmap -
backend-structure.md Backend architecture, Clean Architecture layers, component diagrams -
frontend-structure.md Frontend architecture, React component structure, state management -

Database 🗃️

File Description Last Updated
initial-database-schema.sql SQL schema for database initialization, tables, relationships -

Development 🛠️

File Description Last Updated
how-to-run-vibe.md Instructions for setting up and using Vibe CLI with this project -

Feature Tracking

File Description Last Updated
features/README.md Feature implementation plans and progress tracking -
features/template.md Template for creating new feature plans -

📝 Adding New Documentation

When adding new documentation files, please follow these guidelines:

  1. Choose the right category: Place files in the appropriate subdirectory
  2. Use kebab-case naming: new-document.md not NewDocument.md
  3. Update this README: Add your file to the appropriate table above
  4. Keep it organized: Create new subdirectories if a category grows too large

Suggested Categories

  • architecture/ - System design, component diagrams, technical decisions
  • database/ - Schema, migrations, data models
  • development/ - Setup guides, development workflows, tooling
  • api/ - API documentation, endpoints, contracts (if not using Swagger)
  • testing/ - Test strategies, test data, test cases
  • deployment/ - Deployment guides, CI/CD, infrastructure
  • features/ - Feature specifications, user stories

🔍 Quick Links

💡 Tips

  • Use the search functionality in your code editor to find specific topics across all docs
  • Documentation should be just enough - focus on the "why" not just the "what"
  • Keep documentation up to date with code changes
  • For API documentation, rely on Swagger/OpenAPI where possible

Last updated: May 31, 2025 Need help? Check the AGENTS.md file for development rules and workflows