# fernandosepu/generative-ai-for-beginners architecture

> Architecture diagram of the GitHub repository fernandosepu/generative-ai-for-beginners, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/fernandosepu/generative-ai-for-beginners
- Repository: https://github.com/fernandosepu/generative-ai-for-beginners

## Overview

This repository is not a typical application but rather a comprehensive educational course – “Generative AI for Beginners” – that is organized into 21 lessons. Each lesson teaches a specific concept or includes a hands-on project related to Generative AI (e.g., text generation, image generation, chat applications) with accompanying code samples in various languages like Python, TypeScript, and .NET. The repository also supports multiple languages via dedicated translations folders, provides rich multimedia support (images, presentations), and integrates with continuous integration workflows via GitHub Actions.

##### Main Components
- Course Content:
- A “Course Setup” component for environment configuration (the 00-course-setup directory).
- 21 Lesson modules (directories labeled 01-21), where each lesson can be split into:
 A “Learn” part (educational text, videos, explanation).
 A “Build” part (hands-on coding exercises with multiple sample implementations).
- Code Samples:
- Subdirectories for different programming languages found within individual lesson folders (e.g., Python notebooks, JavaScript or TypeScript projects, .NET projects).
- Shared configuration files such as requirements.txt for Python and package.json for the JavaScript/TypeScript samples.
- Translation Assets:
- Each lesson has its own translations folder with subdirectories for different languages. This can be diagrammed as a separate layer of content localization.
- Documentation & Assets:
- Global README, CONTRIBUTING, CODE_OF_CONDUCT, and SECURITY guidelines.
- Additional assets like images, presentations, and docs in their respective directories.
- DevOps & Configuration:
- The .github folder contains issue templates and workflow files (CI/CD automation).
- .devcontainer, .vscode, and environment variable files (like .env.copy) provide support for development configuration and environment setup.

- “Course Content” as the core narrative flow, with each lesson module sequentially linked (numerically arranged from 00 to 21).
- “Translations” layer as a shared asset that feeds into each lesson module, demonstrating internationalization.

##### Architectural Patterns and Design Principles
- Modular design: Each lesson is encapsulated in its own directory, promoting separation of concerns.
- Multi-language support: The same lesson can have different implementation examples (Python, JavaScript, .NET, etc.). Indicate these as parallel streams under each lesson.
- Asset reusability: Many folders (images, translations, docs) are shared across lessons, showcasing a DRY (Don’t Repeat Yourself) approach.

##### Technologies, Frameworks & Tools
- Sample implementation technologies: Python (with notebooks and requirements files); JavaScript/TypeScript (package.json, tsconfig.json files); .NET (with relevant project files).
- Integration with external services like Azure OpenAI, GitHub Marketplace Model Catalog, and OpenAI API as referenced in the README.

##### Final Advice
- Be detailed in capturing every major segment: the sequential lesson structure, the layered code samples, and supporting assets for deployment, multi-language support, and community engagement (via GitHub actions and documentation).

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Course Setup (00-course-setup)"]:::courseSetup

    subgraph "Course Curriculum"
        B["Lesson 01: Introduction to Gen AI"]:::lesson
        B1["Learn Material"]:::learn
        B2["Build Code Samples"]:::build
        B3["Translations"]:::translation

        C["Lesson 04: Prompt Engineering Fundamentals"]:::lesson
        C1["Learn Material"]:::learn
        C2["Python Code Sample"]:::codeSample
        C3["Translations"]:::translation

        D["Lesson 05: Advanced Prompts"]:::lesson
        D1["Learn Material"]:::learn
        D2["JavaScript Code Sample"]:::codeSample
        D3["Translations"]:::translation

        E["Lesson 06: Text Generation Apps"]:::lesson
        E1["Learn Material"]:::learn
        E2["Python Code Sample"]:::codeSample
        E3["Dotnet Code Sample"]:::codeSample
        E4["Translations"]:::translation

        F["Lesson 21: Meta"]:::lesson
        F1["Learn Material"]:::learn
        F2["Build Code Samples"]:::build
        F3["Translations"]:::translation
    end

    G["Global Documentation & Multimedia"]:::globalDocs
    H["DevOps & Configuration"]:::devops
    H1["GitHub Actions (.github)"]:::devops
    H2["Dev Container (.devcontainer)"]:::devops
    H3["VSCode (.vscode)"]:::devops
    H4["Env File (.env.copy)"]:::devops
    I["Global Translations"]:::translation

    %% Sequential flow of curriculum
    A -->|"init"| B
    B -->|"next"| C
    C -->|"next"| D
    D -->|"next"| E
    E -->|"next"| F

    %% Lesson 01 internal flow
    B --> B1
    B1 --> B2
    B2 --> B3

    %% Lesson 04 internal flow
    C --> C1
    C1 --> C2
    C2 --> C3

    %% Lesson 05 internal flow
    D --> D1
    D1 --> D2
    D2 --> D3

    %% Lesson 06 internal flow
    E --> E1
    E1 --> E2
    E2 --> E3
    E3 --> E4

    %% Lesson 21 internal flow
    F --> F1
    F1 --> F2
    F2 --> F3

    %% Linking lesson translations to Global Translations
    B3 --- I
    C3 --- I
    D3 --- I
    E4 --- I
    F3 --- I

    %% Linking Build components to Global Documentation
    B2 --> G
    C2 --> G
    D2 --> G
    E2 --> G
    F2 --> G

    %% DevOps & Configuration branch
    A --> H
    H --> H1
    H --> H2
    H --> H3
    H --> H4

    %% Global Documentation connection to DevOps (support link)
    G --- H

    %% Click Events
    click A "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/00-course-setup"
    click B "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/01-introduction-to-genai"
    click C "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/04-prompt-engineering-fundamentals"
    click D "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/05-advanced-prompts"
    click E "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/06-text-generation-apps"
    click F "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/21-meta"
    click B3 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/01-introduction-to-genai/translations"
    click C2 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/04-prompt-engineering-fundamentals/python"
    click C3 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/04-prompt-engineering-fundamentals/translations"
    click D2 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/05-advanced-prompts/javascript"
    click D3 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/05-advanced-prompts/translations"
    click E2 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/06-text-generation-apps/python"
    click E3 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/06-text-generation-apps/dotnet"
    click E4 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/06-text-generation-apps/translations"
    click F3 "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/21-meta/translations"
    click I "https://github.com/fernandosepu/generative-ai-for-beginners/tree/main/translations/"
    click H1 "https://github.com/fernandosepu/generative-ai-for-beginners/blob/main/.github"
    click H2 "https://github.com/fernandosepu/generative-ai-for-beginners/blob/main/.devcontainer"
    click H3 "https://github.com/fernandosepu/generative-ai-for-beginners/blob/main/.vscode"
    click H4 "https://github.com/fernandosepu/generative-ai-for-beginners/blob/main/.env.copy"

    %% Class Definitions
    classDef courseSetup fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef lesson fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef learn fill:#E0FFFF,stroke:#000,stroke-width:1px;
    classDef build fill:#FFD700,stroke:#000,stroke-width:1px;
    classDef translation fill:#FFFF99,stroke:#000,stroke-width:1px;
    classDef codeSample fill:#98FB98,stroke:#000,stroke-width:1px;
    classDef globalDocs fill:#DDA0DD,stroke:#000,stroke-width:2px;
    classDef devops fill:#FFA07A,stroke:#000,stroke-width:2px;
```
