lasserh/DeutschLernen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
102 commits 5 branches 0 tags 1 MiB
Find a file
Lasse Rune Hansen 989ffb032c
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
docs: add .env.example with Mistral AI configuration placeholders 
Added .env.example file with all AI service configuration placeholders.
Users should copy this to .env and fill in their actual API keys.
The .env file is already in .gitignore and will not be committed.

This allows users to configure Mistral, Vosk, and Coqui services without
committing sensitive API keys to git.

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
2026-06-17 17:58:37 +02:00
docs feat(backend/auth): Enforce authentication on LessonsEndpoints minimal API GET endpoints 2026-06-14 17:03:30 +02:00
german-app-frontend fix(backend): resolve admin redirect, null reference, and Docker build issues 2026-06-16 17:35:50 +02:00
GermanApp fix(backend): resolve admin redirect, null reference, and Docker build issues 2026-06-16 17:35:50 +02:00
scripts/ai-setup feat(backend/ai-setup): Phase 3 - Model download automation scripts 2026-06-13 10:57:08 +02:00
Tests fix(backend): resolve admin redirect, null reference, and Docker build issues 2026-06-16 17:35:50 +02:00
.dockerignore feat(backend/infra): add Docker configuration for Phase 3 2026-06-05 11:46:27 +02:00
.env.example docs: add .env.example with Mistral AI configuration placeholders 2026-06-17 17:58:37 +02:00
.gitignore chore: add appsettings.json files to .gitignore and remove from repository 2026-06-10 07:01:05 +02:00
.woodpecker.yml chore(ci): add Woodpecker secrets for Mistral API and JWT configuration 2026-06-10 17:24:03 +02:00
AGENTS.md docs: add explicit instruction to update task checkmarks in feature files 2026-06-05 11:41:39 +02:00
docker-compose.yml fix(backend/docker): add Mistral API key from appsettings.Development.json 2026-06-17 17:52:06 +02:00
nuget.config feat(backend): complete unit tests for User Authentication feature 2026-06-05 17:07:15 +02:00

docs/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