# amir22we/cymoe architecture

> Architecture diagram of the GitHub repository amir22we/cymoe, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-03-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/amir22we/cymoe
- Repository: https://github.com/amir22we/cymoe

## Overview

##### Что это за проект и зачем он нужен (контекст для диаграммы)

По дереву и README это **монолитное Django-приложение** (server-side rendered), предназначенное для **ведения заметок/записей** с базовой социальной активностью вокруг записи (как минимум комментарии), и с модулем **аккаунтов/профиля**.

Ключевые признаки:
- `mysite/` — Django project (settings/urls/wsgi/asgi).
- `accounts/` и `blog/` — Django apps (разделение доменов: пользователи/профиль и записи/заметки).
- `templates/` + `blog/static/` — SSR (рендер HTML на сервере) + статика (CSS/JS).
- `db.sqlite3` — SQLite как основная БД.
- `media/profile_images` — пользовательские загрузки (аватары/изображения профиля).
- `python-dotenv` + `.env.example` — конфигурация окружением.
- `staticfiles/` — собранная статика (результат `collectstatic`, важна для прод-диаграммы).

Следовательно, лучшая системная диаграмма здесь — это **контейнерная/компонентная** (C4 Model: Context → Container → Component), где центральный контейнер — Django Web App, а компоненты — Django apps + ключевые подсистемы (ORM, шаблоны, auth, storage).

##### Top-level, которые надо отразить как отдельные элементы на диаграмме
- **Django Web App (monolith)**: `manage.py`, `mysite/*`, `accounts/*`, `blog/*`
- **Database**: `db.sqlite3` (SQLite)
- **Static assets**:
- исходники: `blog/static/*`
- собранная статика: `staticfiles/*` (в прод обычно обслуживается отдельно)
- **Templates**: `templates/*` (страницы auth, профиль, заметки, ошибки)
- **Media uploads**: `media/profile_images/*` (файловое хранилище)
- **Config/Secrets**: `.env` (через python-dotenv), `requirements.txt`

##### Внутренние “подкомпоненты” Django, которые стоит обозначить стрелками
- **URL routing**: `mysite/urls.py`, `accounts/urls.py`, `blog/urls.py`
- **Views/Controllers**: `accounts/views.py`, `blog/views.py`
- **Forms/Validation**: `accounts/forms.py`, `blog/forms.py`
- **Domain/Models (ORM)**: `accounts/models.py`, `blog/models.py` + миграции
- **Auth & sessions**: встроенный Django auth (явно не в дереве, но очевидно по `registration/` шаблонам и login/logout URL)
- **Signals**: `accounts/signals.py` (автосоздание/обновление профиля или подобные side-effects)
- **Admin**: `accounts/admin.py`, `blog/admin.py`
- **Templatetags**: `blog/templatetags/blog_tags.py` (кастомные теги/фильтры)
- **Sitemaps**: `blog/sitemaps.py` (генерация sitemap для SEO/индексации)

##### Клиенты
- **Web Browser (User)**: взаимодействует по HTTP(S), получает HTML/CSS/JS.
- (Опционально) **Admin user**: тот же браузер, но поток в `/admin/`.

##### Серверная часть (единый контейнер: Django)
Внутри контейнера имеет смысл выделить 2 крупных компонента (как bounded contexts):
##### Accounts app
- User registration/login/logout (Django auth)
- Profile management: смена имени/пароля, удаление аккаунта
- Profile model + avatar (media)
- Signals (жизненный цикл профиля)

##### Blog app (по факту “Notes”)
- Post CRUD (create + view own + view all + detail by id)
- Comments (по миграции `0010_comment.py`)
- Tags (по миграциям `post_tags`, `CustomTag`, `TaggedPost` и т.п.)
- Search / share / similar posts (видно по шаблонам `search.html`, `share.html`, `similar_posts.css`)
- Sitemaps + templatetags

Плюс общие для обоих:
- **Templates renderer** (`templates/*`)
- **Static pipeline** (исходники `blog/static/*` → `staticfiles/*`)
- **Session middleware / CSRF / Auth** (как “Django framework services” внутри контейнера)

##### Данные и хранилища
- **SQLite DB**: хранит пользователей, профили, посты, комментарии, теги, сессии и т.д.
- **Media filesystem**: хранит загруженные изображения профиля.
- **Static files store**: в деве может отдавать Django, в прод — отдельный сервер/объектное хранилище/NGINX.

##### Взаимодействия и стрелки (что с чем говорит)

Рекомендуемый набор стрелок (минимум, но “точно”):
1) **Browser → Django (HTTP)**: запрос страниц `/`, `/register/`, `/login_user/`, `/create_note/`, `/post/<id>/` и т.д.
##### Django Views → Templates: рендер HTML (SSR).
3) **Django Views/Models → SQLite (ORM queries)**: чтение/запись Post/Comment/User/Profile/Tag.
##### Django → Media storage: чтение/запись аватара (upload) в `media/profile_images`.
5) **Browser → Static files**: загрузка CSS/JS/картинок (в деве через Django, в прод часто через NGINX/Whitenoise — укажите выбранный вариант).

Если хотите диаграмму “максимально разделённую на компоненты”, добавьте внутренние стрелки:
- URLConf → View → Form validation → ORM(Model) → DB → View → Template → Response
- Accounts signals → ORM → DB (например, создание Profile при создании User)

##### Архитектурные паттерны/принципы, которые стоит явно подписать

- **Django MVT** (Model–Template–View; “View” выполняет роль контроллера, Template — представление).
- **Monolith modularized by apps**: `accounts` и `blog` как модули.
- **Server-side rendering**: основная UI-логика в шаблонах, JS — для интерактивности.
- **Configuration via environment**: `.env` → `mysite/settings.py`.
- **Persistence via ORM + migrations**: `migrations/` как контроль схемы.
- **Static vs Media separation**: `staticfiles/` (build artifact) vs `media/` (user uploads).

##### Шаг 1: Диаграмма уровня контекста (System Context)
Нарисуйте 3–5 блоков:
- Пользователь (Browser)
- CYMOE (Django Notes App)
- SQLite DB
- File Storage (Media)
- (Опционально) Admin user (как роль)

Подпишите: “HTML over HTTP”, “ORM”, “file upload”.

##### Шаг 2: Диаграмма контейнеров (Container)
Для текущего проекта контейнеров немного:
- Web Client (Browser)
- Web Server / App Server: Django (WSGI/ASGI entrypoints: `mysite/wsgi.py`, `mysite/asgi.py`)
- Database: SQLite
- Static files serving (либо “Django dev server”, либо “Nginx/Static hosting” как отдельный контейнер — выберите целевое окружение)
- Media storage (filesystem)

Если диаграмма для прод-архитектуры: логично добавить Reverse proxy (Nginx) перед Django и выделить “Static/Media served by Nginx”. Если диаграмма только “как в репо/дев”, можно оставить “Django dev server serves everything”.

##### Шаг 3: Диаграмма компонентов внутри Django (Component)
Внутри “Django App” разложите на:
- `mysite/urls.py` (root router)
- `accounts` app:
- urls.py
- views.py
- forms.py
- models.py (Profile, связь с User)
- signals.py
- `blog` app:
- urls.py
- views.py
- forms.py
- models.py (Post, Comment, Tag…)
- templatetags/blog_tags.py
- sitemaps.py
- Shared Django framework services: Auth, Sessions, CSRF, Admin
- Templates (`templates/...`) как отдельный компонент, к которому обращаются views
- Static sources (`blog/static/...`) и collected (`staticfiles/...`) — как “assets”

Стрелки внутри: Router → app router → view → form/model → DB; view → template.

##### Шаг 4: (Опционально, но “самое точное”) Диаграмма основных user flows
Сделайте 2–4 sequence/flow диаграммы:
- Регистрация/логин: Browser → accounts views → Django auth → DB → redirect/profile
- Создание заметки: Browser → blog views + blog form → Post model → DB → success page
- Просмотр “мои записи”/“все записи”: Browser → blog views → ORM query (filter by user / all) → template
- Upload avatar: Browser multipart upload → accounts view/form → media storage + DB(Profile.avatar path)

##### Явные подписи технологий/артефактов
- “Python, Django 6.0.2”
- “SQLite (db.sqlite3)”
- “Django Templates (`templates/`)”
- “Static (`blog/static/` → `staticfiles/`)”
- “Media uploads (`media/profile_images/`)”
- “dotenv (.env)”

##### Подписи доменных сущностей (минимальный набор)
- User (Django auth)
- Profile (accounts)
- Post (blog)
- Comment (blog)
- Tag / tagging relation (blog)

##### Стандарты оформления (чтобы principal-engineer уровень был “читабельный и полный”)

- **Чёткие лейблы**: “accounts app”, “blog app”, “SQLite DB”, “Media FS”, “Templates”.
- **Направленные стрелки**:
- HTTP request/response (Browser ↔ Django)
- ORM queries (Django → DB)
- File read/write (Django → Media)
- Static fetch (Browser → Static serving)
- **Цвет/формы** (рекомендация):
- Синие прямоугольники: runtime компоненты (Browser, Django, DB)
- Серые: storage (SQLite, media, static)
- Пунктир: build/deploy artifacts (staticfiles, migrations)
- **Не бойтесь дробить**: в этом проекте лучше показать “лишний” компонент (signals/templatetags/sitemaps), чем спрятать важную часть поведения.

##### Готовая “заготовка” структуры диаграммы (что именно рисовать блоками)

**System (CYMOE)**
- Django Web App
- accounts (auth, profile, signals)
- blog (posts, comments, tags, sitemaps, templatetags)
- templates renderer
- admin
- SQLite (db.sqlite3)
- Static files (blog/static → staticfiles)
- Media (media/profile_images)

**Actors**
- User (Browser)
- Admin (Browser)

Добавьте основные URL-группы как подписи рядом с “accounts” и “blog” (из README) — это делает диаграмму “привязанной к реальности”.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    User["User<br/>(Web Browser)"]:::actor
    AdminUser["Admin User<br/>(Web Browser)"]:::actor

    %% Edge / delivery
    subgraph "Delivery / Serving"
        direction TB
        StaticServing["Static Files Serving<br/>(dev: Django / prod: separate)"]:::edge
    end

    %% System boundary
    subgraph "CYMOE Notes System (Django Monolith)"
        direction TB

        Manage["Django Management Entrypoint<br/>(manage.py)"]:::runtime

        subgraph "Django Project Core (mysite/)"
            direction TB
            Settings["Settings & Env Config<br/>(python-dotenv → settings.py)"]:::runtime
            RootURLs["Root URLConf<br/>(urls.py)"]:::runtime
            WSGI["WSGI Entrypoint<br/>(wsgi.py)"]:::runtime
            ASGI["ASGI Entrypoint<br/>(asgi.py)"]:::runtime
            FrameworkServices["Django Framework Services<br/>(Auth, Sessions, CSRF, Middleware)"]:::runtime
            AdminSite["Django Admin Site<br/>(/admin/)"]:::runtime
        end

        subgraph "Accounts App (accounts/)"
            direction TB
            AccURLs["accounts/urls.py<br/>(/register/, /login/, /profile/...)"]:::runtime
            AccViews["Views / Controllers<br/>(accounts/views.py)"]:::runtime
            AccForms["Forms / Validation<br/>(accounts/forms.py)"]:::runtime
            AccModels["Models (ORM)<br/>(accounts/models.py)<br/>Profile ↔ User"]:::runtime
            AccSignals["Signals<br/>(accounts/signals.py)<br/>(profile lifecycle)"]:::runtime
            AccAdmin["Admin Integration<br/>(accounts/admin.py)"]:::runtime
            AccMigrations["Migrations<br/>(accounts/migrations/)"]:::artifact
        end

        subgraph "Blog / Notes App (blog/)"
            direction TB
            BlogURLs["blog/urls.py<br/>(/, /create_note/, /post/&lt;id&gt;/...)"]:::runtime
            BlogViews["Views / Controllers<br/>(blog/views.py)"]:::runtime
            BlogForms["Forms / Validation<br/>(blog/forms.py)"]:::runtime
            BlogModels["Models (ORM)<br/>(blog/models.py)<br/>Post, Comment, Tag"]:::runtime
            BlogTags["Template Tags<br/>(blog/templatetags/blog_tags.py)"]:::runtime
            BlogSitemaps["Sitemaps<br/>(blog/sitemaps.py)"]:::runtime
            BlogAdmin["Admin Integration<br/>(blog/admin.py)"]:::runtime
            BlogMigrations["Migrations<br/>(blog/migrations/)<br/>(comments/tags)"]:::artifact
        end

        subgraph "Presentation (SSR)"
            direction TB
            TemplatesRoot["Templates Directory<br/>(templates/)"]:::ui
            TemplatesReg["Auth Templates<br/>(templates/registration/)"]:::ui
            TemplatesProfile["Profile Templates<br/>(templates/profile/)"]:::ui
            TemplatesNotes["Notes Templates<br/>(templates/notes/)"]:::ui
            BaseTemplate["Shared Base Template<br/>(templates/base.html)"]:::ui
        end

        subgraph "Assets (Static)"
            direction TB
            StaticSrc["Static Sources<br/>(blog/static/)"]:::asset
            StaticCSS["CSS<br/>(blog/static/css/)"]:::asset
            StaticJS["JS<br/>(blog/static/scripts/)"]:::asset
            StaticIMG["Images<br/>(blog/static/img/)"]:::asset
            StaticCollected["Collected Static (deploy artifact)<br/>(staticfiles/)"]:::artifact
            StaticManifest["Staticfiles Manifest<br/>(staticfiles/staticfiles.json)"]:::artifact
        end

        subgraph "Data Stores"
            direction TB
            SQLite["SQLite Database<br/>(db.sqlite3)"]:::storage
            MediaRoot["Media Uploads Root<br/>(media/)"]:::storage
            ProfileImages["Profile Images Storage<br/>(media/profile_images/)"]:::storage
        end

        subgraph "Build / Dependencies"
            direction TB
            Requirements["Python Dependencies<br/>(requirements.txt)"]:::artifact
            EnvExample["Environment Example<br/>(.env.example)"]:::artifact
        end
    end

    %% External interactions
    User -->|"HTTP(S):SSR_requests"| RootURLs
    AdminUser -->|"HTTP(S):/admin/"| AdminSite

    %% URL routing paths
    RootURLs -->|"route /accounts/*"| AccURLs
    RootURLs -->|"route /blog/*"| BlogURLs
    RootURLs -->|"route /admin/"| AdminSite

    %% Accounts MVT flow
    AccURLs -->|"dispatch"| AccViews
    AccViews -->|"validate"| AccForms
    AccViews -->|"use_auth/sessions"| FrameworkServices
    AccViews -->|"ORM_read/write"| AccModels
    AccModels -->|"ORM_queries"| SQLite
    AccSignals -->|"side_effects ORM"| AccModels
    AccViews -->|"render"| TemplatesRoot
    AccViews -->|"render auth pages"| TemplatesReg
    AccViews -->|"render profile pages"| TemplatesProfile
    TemplatesRoot -->|"extends/includes"| BaseTemplate
    TemplatesReg -->|"extends"| BaseTemplate
    TemplatesProfile -->|"extends"| BaseTemplate

    %% Blog MVT flow
    BlogURLs -->|"dispatch"| BlogViews
    BlogViews -->|"validate"| BlogForms
    BlogViews -->|"use_auth/sessions"| FrameworkServices
    BlogViews -->|"ORM_read/write"| BlogModels
    BlogModels -->|"ORM_queries"| SQLite
    BlogViews -->|"render notes"| TemplatesNotes
    BlogViews -->|"use"| BlogTags
    BlogSitemaps -->|"query for sitemap"| BlogModels
    TemplatesNotes -->|"extends"| BaseTemplate

    %% Media uploads
    AccViews -->|"upload/read avatar"| ProfileImages
    ProfileImages -->|"stored_under"| MediaRoot
    AccModels -->|"store path/metadata"| SQLite

    %% Static assets pipeline
    StaticSrc -->|"collectstatic"| StaticCollected
    StaticCollected -->|"manifest"| StaticManifest
    User -->|"GET /static/*"| StaticServing
    StaticServing -->|"serve"| StaticCollected

    %% Admin usage of models
    AdminSite -->|"manage"| AccAdmin
    AdminSite -->|"manage"| BlogAdmin
    AccAdmin -->|"ORM"| AccModels
    BlogAdmin -->|"ORM"| BlogModels

    %% Migrations -> DB (schema versioning)
    AccMigrations -->|"apply schema"| SQLite
    BlogMigrations -->|"apply schema"| SQLite

    %% Click events (mapped components)
    click Manage "https://github.com/amir22we/cymoe/blob/main/manage.py"
    click Settings "https://github.com/amir22we/cymoe/blob/main/mysite/settings.py"
    click RootURLs "https://github.com/amir22we/cymoe/blob/main/mysite/urls.py"
    click WSGI "https://github.com/amir22we/cymoe/blob/main/mysite/wsgi.py"
    click ASGI "https://github.com/amir22we/cymoe/blob/main/mysite/asgi.py"

    click AccURLs "https://github.com/amir22we/cymoe/blob/main/accounts/urls.py"
    click AccViews "https://github.com/amir22we/cymoe/blob/main/accounts/views.py"
    click AccForms "https://github.com/amir22we/cymoe/blob/main/accounts/forms.py"
    click AccModels "https://github.com/amir22we/cymoe/blob/main/accounts/models.py"
    click AccSignals "https://github.com/amir22we/cymoe/blob/main/accounts/signals.py"
    click AccAdmin "https://github.com/amir22we/cymoe/blob/main/accounts/admin.py"
    click AccMigrations "https://github.com/amir22we/cymoe/tree/main/accounts/migrations/"
    click BlogURLs "https://github.com/amir22we/cymoe/blob/main/blog/urls.py"
    click BlogViews "https://github.com/amir22we/cymoe/blob/main/blog/views.py"
    click BlogForms "https://github.com/amir22we/cymoe/blob/main/blog/forms.py"
    click BlogModels "https://github.com/amir22we/cymoe/blob/main/blog/models.py"
    click BlogMigrations "https://github.com/amir22we/cymoe/tree/main/blog/migrations/"
    click BlogSitemaps "https://github.com/amir22we/cymoe/blob/main/blog/sitemaps.py"
    click BlogTags "https://github.com/amir22we/cymoe/blob/main/blog/templatetags/blog_tags.py"
    click BlogAdmin "https://github.com/amir22we/cymoe/blob/main/blog/admin.py"

    click TemplatesRoot "https://github.com/amir22we/cymoe/tree/main/templates/"
    click TemplatesReg "https://github.com/amir22we/cymoe/tree/main/templates/registration/"
    click TemplatesProfile "https://github.com/amir22we/cymoe/tree/main/templates/profile/"
    click TemplatesNotes "https://github.com/amir22we/cymoe/tree/main/templates/notes/"
    click BaseTemplate "https://github.com/amir22we/cymoe/blob/main/templates/base.html"

    click StaticSrc "https://github.com/amir22we/cymoe/tree/main/blog/static/"
    click StaticCSS "https://github.com/amir22we/cymoe/tree/main/blog/static/css/"
    click StaticJS "https://github.com/amir22we/cymoe/tree/main/blog/static/scripts/"
    click StaticIMG "https://github.com/amir22we/cymoe/tree/main/blog/static/img/"
    click StaticCollected "https://github.com/amir22we/cymoe/tree/main/staticfiles/"
    click StaticManifest "https://github.com/amir22we/cymoe/blob/main/staticfiles/staticfiles.json"

    click SQLite "https://github.com/amir22we/cymoe/blob/main/db.sqlite3"
    click MediaRoot "https://github.com/amir22we/cymoe/tree/main/media/"
    click ProfileImages "https://github.com/amir22we/cymoe/tree/main/media/profile_images/"

    click EnvExample "https://github.com/amir22we/cymoe/blob/main/.env.example"
    click Requirements "https://github.com/amir22we/cymoe/blob/main/requirements.txt"

    %% Styles
    classDef actor fill:#E3F2FD,stroke:#1565C0,stroke-width:1.5px,color:#0D47A1
    classDef runtime fill:#E8F5E9,stroke:#2E7D32,stroke-width:1.5px,color:#1B5E20
    classDef ui fill:#FFF3E0,stroke:#EF6C00,stroke-width:1.5px,color:#E65100
    classDef storage fill:#ECEFF1,stroke:#455A64,stroke-width:1.5px,color:#263238
    classDef asset fill:#F3E5F5,stroke:#6A1B9A,stroke-width:1.5px,color:#4A148C
    classDef artifact fill:#FAFAFA,stroke:#616161,stroke-width:1.2px,color:#424242,stroke-dasharray: 5 4
    classDef edge fill:#E0F7FA,stroke:#00838F,stroke-width:1.5px,color:#004D40
```
