# virgilio/crossingstreams architecture

> Architecture diagram of the GitHub repository virgilio/crossingstreams, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/virgilio/crossingstreams
- Repository: https://github.com/virgilio/crossingstreams

## Overview

##### Project type and purpose
- Crossing Streams is a full-stack, containerized web application.
- Backend: Django + Django REST Framework providing an API, sending emails, and persisting to PostgreSQL.
- Frontend: ReactJS single-page-app (SPA) using Axios, React Bootstrap, React-Youtube, served by Nginx.
- Workflow: user submits email + YouTube video ID → backend generates edit/embed/stats links → emails user → front-end handles Create/Edit/Stats views → external YouTube player in the embed.

##### File structure
- Top-level “compose/” folders define three Docker containers:
- compose/django – Dockerfile + entrypoint/start scripts for the API
- compose/react – Dockerfile + start script for the React app
- compose/nginx – Dockerfile + default.conf for serving the SPA + proxying API calls
- “cs_backend” directory: Django project (“crossingstreams”) + “video” app (models, serializers, views, URLs, migrations)
- “cs_frontend” directory: React app organized into “views” (Create, Edit, Embed, Stats) and “cyoa” components
- docker-compose.yaml orchestrates all services along with environment configs in “.envs/”

##### README insights
- Confirms stack: Django + PostgreSQL + DRF; ReactJS + Bootstrap + Axios + React-Youtube.
- Core entities: Video, Activities, Options, Actions.
- Future plans: CI/CD, deployment pipeline, tests.

##### Main components and interactions
a. Components
- Browser / React SPA (container: react)
- Nginx reverse proxy & static server (container: nginx)
- Django REST API (container: django)
- PostgreSQL database (container: postgres, env in .envs/.postgres)
- SMTP/email service (external or via Django config)
- External YouTube API/player (external service)
b. Relationships & Data flow
1. Browser → Nginx: GET / (serves index.html & static assets)
2. Browser ↔ Nginx → Django API: HTTP(S) REST calls (Axios)
3. Django API ↔ PostgreSQL: ORM SQL queries (models → migrations)
4. Django API → SMTP: sends email with edit/embed/stats links
5. Browser → YouTube: embed JS player requests
c. Architectural patterns
- MVC in Django with a REST layer.
- SPA on the frontend.
- Container-oriented microservice boundary via Docker Compose.
- Clear separation of concerns: UI / API / Data.
d. Key technologies
- Django, Django REST Framework, PostgreSQL
- ReactJS, React Bootstrap, Axios, React-Youtube
- Nginx as reverse proxy + static file server
- Docker Compose orchestrator

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Tier
    Browser["Browser\n(React SPA)"]:::frontend

    %% Docker Compose Boundary
    subgraph "Docker Compose"
        direction TB

        %% React Container
        subgraph "React Container"
            direction TB
            React["React SPA\n(Axios, Bootstrap, React-Youtube)"]:::frontend
            subgraph "SPA Views"
                direction TB
                Create["Create View"]:::frontend
                Edit["Edit View"]:::frontend
                Embed["Embed View"]:::frontend
                Stats["Stats View"]:::frontend
                YTP["YoutubePlayer Component"]:::frontend
            end
        end

        %% Nginx Container
        subgraph "Nginx Container"
            Nginx["Nginx\nReverse Proxy & Static Server"]:::service
        end

        %% Django Container
        subgraph "Django Container"
            Django["Django REST API\n(DRF, ORM)"]:::service
        end

        %% PostgreSQL Container
        subgraph "PostgreSQL Container"
            Postgres[(PostgreSQL DB)]:::db
        end

        %% Environment Configs
        envs[".envs"]:::external
    end

    %% External Services
    SMTP["SMTP / Email Service"]:::external
    YouTube["YouTube API / Player"]:::external

    %% Data Flows
    Browser -->|"HTTP GET /"| Nginx
    Browser -->|"REST API (Axios)"| Nginx
    Nginx -->|"Proxy /api"| Django
    Django -->|"SQL over TCP"| Postgres
    Django -->|"SMTP"| SMTP
    Browser -->|"Embed Player"| YouTube

    %% Env loading
    envs --> React
    envs --> Django
    envs --> Postgres

    %% Click Events
    click React "https://github.com/virgilio/crossingstreams/tree/master/compose/react/Dockerfile"
    click React "https://github.com/virgilio/crossingstreams/tree/master/compose/react/start"
    click React "https://github.com/virgilio/crossingstreams/tree/master/cs_frontend/"
    click Browser "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/public/index.html"
    click Browser "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/index.js"
    click Browser "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/App.js"
    click Create "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/views/video/Create.js"
    click Edit "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/views/video/Edit.js"
    click Embed "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/views/video/Embed.js"
    click Stats "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/views/video/Stats.js"
    click YTP "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/cyoa/YoutubePlayer.js"
    click Nginx "https://github.com/virgilio/crossingstreams/tree/master/compose/nginx/Dockerfile"
    click Nginx "https://github.com/virgilio/crossingstreams/blob/master/compose/nginx/default.conf"
    click Django "https://github.com/virgilio/crossingstreams/tree/master/compose/django/Dockerfile"
    click Django "https://github.com/virgilio/crossingstreams/tree/master/compose/django/entrypoint"
    click Django "https://github.com/virgilio/crossingstreams/tree/master/compose/django/start"
    click Django "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/manage.py"
    click Django "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/crossingstreams/settings.py"
    click Django "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/crossingstreams/urls.py"
    click Django "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/crossingstreams/wsgi.py"
    click Django "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/requirements.txt"
    click Postgres "https://github.com/virgilio/crossingstreams/blob/master/docker-compose.yaml"
    click Postgres "https://github.com/virgilio/crossingstreams/blob/master/.envs/.postgres"
    click SMTP "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/video/templates/new_video_email.html"
    click SMTP "https://github.com/virgilio/crossingstreams/blob/master/cs_backend/crossingstreams/settings.py"
    click YouTube "https://github.com/virgilio/crossingstreams/blob/master/cs_frontend/src/cyoa/YoutubePlayer.js"
    click envs "https://github.com/virgilio/crossingstreams/blob/master/docker-compose.yaml"
    click envs "https://github.com/virgilio/crossingstreams/blob/master/.envs/.django"
    click envs "https://github.com/virgilio/crossingstreams/blob/master/.envs/.react"
    click envs "https://github.com/virgilio/crossingstreams/blob/master/.envs/.postgres"

    %% Styles
    classDef frontend fill:#B3CDE0,stroke:#03396C,color:#03396C
    classDef service fill:#C7E9B4,stroke:#2CA25F,color:#2CA25F
    classDef db fill:#A6BDD7,stroke:#08519C,color:#08519C
    classDef external fill:#E0E0E0,stroke:#636363,color:#636363
```
