# iamrajatroy/movys architecture

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

- Interactive diagram: https://gitdiagram.com/iamrajatroy/movys
- Repository: https://github.com/iamrajatroy/movys

## Overview

##### Project type and purpose
- This is a full-stack movie recommendation application.
- Frontend: Angular SPA, built under `src/main/ui` and bundled into the Spring Boot JAR (served via Thymeleaf/static).
- Backend: Spring Boot (Java) REST API under `src/main/java/com/codeit/rajat/movys`.
- Recommendation microservice: Python Flask app under `python_code/movie_recommender`, containerized with Docker.
- Data store: in-memory Apache Derby (embedded in Spring Boot).
- Offline data ingestion: Python notebooks under `python_code` use TMDb API to fetch and clean movie data.

##### File structure
- Top level:
- `pom.xml`, `.mvn`, `mvnw`: Java build (Maven) for Spring Boot
- `src/main/java/...`: Spring Boot application, organized by packages (config, component, controller, service, persistence) following MVC + repository pattern
- `src/main/resources`: Derby CSV under `db/`, Thymeleaf template `index.html`, static assets (Angular build output) under `static/js`, `static/css`
- `src/main/ui`: Angular source—modules, components, services—built via `package.json` scripts into `dist` and copied into `resources/static`
- `python_code/movie_recommender`: Flask recommender service, `Dockerfile`, `docker-compose.yml`
- `demo`: screenshots/GIF for README

##### README for additional insights
- Describes data flow: user likes movies → Java backend persists in Derby → backend calls recommendation service (Flask in Docker) → Flask returns similar movies → backend responds to Angular UI.

a. Main components
1. Client Browser / User Interface (Angular SPA)
2. Spring Boot Application (Java)
3. Python Flask Recommender Service (Docker container)
4. In-memory Derby Database
5. (Optional) External TMDb API for data ingestion

b. Relationships & interactions
- User ↔ Angular UI (HTTP)
- Angular UI → Spring Boot REST endpoints (`/api/movies`, `/api/recommend`)
- Spring Boot → Derby (JDBC repositories) for CRUD on movies and user likes
- Spring Boot → Python Flask service (HTTP over Docker network) to compute recommendations
- (Offline) Python notebooks ↔ TMDb API to fetch raw movie data

c. Architectural patterns & design principles
- MVC on Spring Boot: controllers → services → repositories
- Microservice boundary: content-based recommender isolated in Flask/Docker
- Single-page application served as static assets by Spring Boot + Thymeleaf shell
- Embedded in-memory DB for simplicity and zero-ops persistence
- Docker Compose for orchestrating the Python service

d. Key technologies
- Java / Spring Boot / Spring Data JPA / Apache Derby
- Angular / TypeScript / RxJS
- Python / Flask / scikit-learn (content-based filtering)
- Docker / Docker Compose

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client"
        direction TB
        Browser["Angular SPA"]:::frontend
        StaticAssets["Built Static Assets\n(js/css + index.html)"]:::frontend
    end

    %% Backend Layer
    subgraph "Spring Boot Application" 
        direction TB
        MovysApp["MovysApplication"]:::backend
        subgraph "Controllers"
            direction TB
            LandingController["LandingController"]:::backend
            MoviesApi["MoviesApi"]:::backend
        end
        subgraph "Services"
            direction TB
            MovieService["MovieService"]:::backend
            RecommenderServiceCaller["RecommenderServiceCaller"]:::backend
        end
        subgraph "Persistence (JPA)"
            direction TB
            MovieRepo["MovieRepository"]:::backend
            LikedMovieRepo["LikedMovieRepository"]:::backend
            Entities["Entities"]:::backend
        end
    end

    %% Microservice Layer
    subgraph "Docker Container\n(Flask Recommender)" 
        direction TB
        Recommender["Flask Recommender\n(recommender.py)"]:::micro
        Indices["indices.csv\nindices_may20.csv"]:::micro
        DockerCfg["Dockerfile\ndocker-compose.yml"]:::micro
    end

    %% Database Layer
    DerbyDB["Apache Derby DB\n(tmdb_movies_may_20_clean.csv)"]:::database

    %% Offline Ingestion
    subgraph "Offline Data Ingestion"
        direction TB
        Notebooks["TMDb Notebooks\n(Movies_Similarity.ipynb,\nclean_data-checkpoint.ipynb)"]:::offline
        TMDbAPI["TMDb API"]:::external
    end

    %% Connections
    Browser -->|"HTTP/REST"| MoviesApi
    Browser -->|"Served assets"| StaticAssets
    StaticAssets --> MovysApp
    MoviesApi -->|calls| MovieService
    LandingController -->|calls| MovieService
    MovieService -->|JPA| MovieRepo
    MovieService -->|JPA| LikedMovieRepo
    MovieService -->|uses| Entities
    RecommenderServiceCaller -->|"HTTP"| Recommender
    Recommender -->|reads| Indices
    MovysApp -->|JDBC| DerbyDB
    RecommenderServiceCaller --> Recommender
    Notebooks -->|"calls"| TMDbAPI

    %% Click Events
    click Browser "https://github.com/iamrajatroy/movys/tree/master/src/main/ui"
    click StaticAssets "https://github.com/iamrajatroy/movys/tree/master/src/main/resources/static/js"
    click StaticAssets "https://github.com/iamrajatroy/movys/tree/master/src/main/resources/static/css"
    click StaticAssets "https://github.com/iamrajatroy/movys/blob/master/src/main/resources/templates/index.html"
    click MovysApp "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/MovysApplication.java"
    click LandingController "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/controller/LandingController.java"
    click MoviesApi "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/controller/MoviesApi.java"
    click MovieService "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/service/MovieService.java"
    click RecommenderServiceCaller "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/service/RecommenderServiceCaller.java"
    click MovieRepo "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/persistence/MovieRepository.java"
    click LikedMovieRepo "https://github.com/iamrajatroy/movys/blob/master/src/main/java/com/codeit/rajat/movys/persistence/LikedMovieRepository.java"
    click Entities "https://github.com/iamrajatroy/movys/tree/master/src/main/java/com/codeit/rajat/movys/persistence/object"
    click DerbyDB "https://github.com/iamrajatroy/movys/blob/master/src/main/resources/db/tmdb_movies_may_20_clean.csv"
    click DerbyDB "https://github.com/iamrajatroy/movys/blob/master/src/main/resources/application.properties"
    click Recommender "https://github.com/iamrajatroy/movys/blob/master/python_code/movie_recommender/recommender.py"
    click DockerCfg "https://github.com/iamrajatroy/movys/tree/master/python_code/movie_recommender/Dockerfile"
    click DockerCfg "https://github.com/iamrajatroy/movys/blob/master/python_code/movie_recommender/docker-compose.yml"
    click Indices "https://github.com/iamrajatroy/movys/blob/master/python_code/movie_recommender/indices.csv"
    click Indices "https://github.com/iamrajatroy/movys/blob/master/python_code/movie_recommender/indices_may20.csv"
    click Notebooks "https://github.com/iamrajatroy/movys/blob/master/python_code/Movies_Similarity.ipynb"
    click Notebooks "https://github.com/iamrajatroy/movys/blob/master/python_code/clean_data-checkpoint.ipynb"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#1E90FF,color:#000
    classDef backend fill:#E6F4EA,stroke:#2E8B57,color:#000
    classDef micro fill:#FFE5B4,stroke:#FFA500,color:#000
    classDef database fill:#F5F5F5,stroke:#A9A9A9,color:#000
    classDef offline fill:#EFEFEF,stroke:#808080,color:#000
    classDef external fill:#FFFFFF,stroke:#000000,color:#000,stroke-dasharray: 5 5
```
