# sathwikhbhat/journal-app architecture

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

- Interactive diagram: https://gitdiagram.com/sathwikhbhat/journal-app
- Repository: https://github.com/sathwikhbhat/journal-app

## Overview

##### Project type and purpose
- This is a backend‐only, RESTful journaling service built with Spring Boot (Java) and MongoDB.
- It exposes secure CRUD endpoints for journal entries and user management, performs custom sentiment analysis, and sends weekly email summaries via SMTP.

##### File structure
- Top‐level: pom.xml, Maven wrapper files, README.
- src/main/java/com/sathwikhbhat/journalapp:
- config/ → SpringSecurity, Swagger, global exception handler
- controller/ → PublicController (signup/login), UserController, JournalEntryController, AdminController
- filter/ → JwtFilter (validates incoming tokens)
- service/ → business logic: UserService, JournalEntryService, EmailService, UserDetailsServiceImpl
- repository/ → MongoDB access: JournalEntryRepository, UserRepository (+ custom impl)
- entity/ → domain objects: User, JournalEntry
- enums/utility/ → Sentiment enum, JwtUtil
- scheduler/ → scheduled weekly email trigger (UserScheduler)
- src/main/resources: application.yml (MongoDB URI, mail creds), logback.xml
- src/test: JUnit/Mockito tests

##### README
- Confirms the architecture, tech stack (Java, Spring Boot, MongoDB, JWT, Gmail SMTP).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Actors
    User["User (Web/Mobile)"]:::external
    Gmail["Gmail SMTP"]:::external

    %% Database
    MongoDB["MongoDB Atlas"]:::data

    %% Application Entry
    App["JournalApplication\n(Spring Boot)"]:::app

    click App "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/JournalApplication.java"

    %% Configuration Layer
    subgraph "Configuration Layer"
        SecConfig["SpringSecurity\n(Spring Security Config)"]:::security
        Swagger["SwaggerConfig\n(Swagger UI)"]:::external
        ExceptionHandler["GlobalExceptionHandler\n(@ControllerAdvice)"]:::security
    end

    click SecConfig "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/config/SpringSecurity.java"
    click Swagger "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/config/SwaggerConfig.java"
    click ExceptionHandler "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/config/GlobalExceptionHandler.java"

    %% Security Filter
    JwtFilter["JwtFilter\n(Token Validation)"]:::security
    click JwtFilter "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/filter/JwtFilter.java"

    %% Controllers Layer
    subgraph "Controllers (Presentation)" 
        PublicCtrl["PublicController\n(Signup/Login)"]:::controller
        UserCtrl["UserController\n(User Ops)"]:::controller
        JournalCtrl["JournalEntryController\n(Journal CRUD)"]:::controller
        AdminCtrl["AdminController\n(Admin Ops)"]:::controller
    end

    click PublicCtrl "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/controller/PublicController.java"
    click UserCtrl "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/controller/UserController.java"
    click JournalCtrl "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/controller/JournalEntryController.java"
    click AdminCtrl "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/controller/AdminController.java"

    %% Service Layer
    subgraph "Services & Business Logic"
        UserService["UserService\n(@Service)"]:::service
        JournalService["JournalEntryService\n(@Service)"]:::service
        EmailService["EmailService\n(@Service)"]:::service
        UserDetailsService["UserDetailsServiceImpl\n(Security)"]:::service
    end

    click UserService "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/service/UserService.java"
    click JournalService "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/service/JournalEntryService.java"
    click EmailService "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/service/EmailService.java"
    click UserDetailsService "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/service/UserDetailsServiceImpl.java"

    %% Data Access Layer
    subgraph "Repositories (Data Access)"
        UserRepo["UserRepository\n(Spring Data Mongo)"]:::data
        UserRepoImpl["UserRepositoryImpl\n(Custom Impl)"]:::data
        JournalRepo["JournalEntryRepository\n(Spring Data Mongo)"]:::data
    end

    click UserRepo "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/repository/UserRepository.java"
    click UserRepoImpl "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/repository/UserRepositoryImpl.java"
    click JournalRepo "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/repository/JournalEntryRepository.java"

    %% Entities & Utilities
    subgraph "Domain & Utilities"
        UserEntity["User\n(Entity)"]:::data
        JournalEntity["JournalEntry\n(Entity)"]:::data
        SentimentEnum["Sentiment\n(Enum)"]:::data
        JwtUtil["JwtUtil\n(Token Ops)"]:::data
    end

    click UserEntity "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/entity/User.java"
    click JournalEntity "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/entity/JournalEntry.java"
    click SentimentEnum "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/enums/Sentiment.java"
    click JwtUtil "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/utility/JwtUtil.java"

    %% Scheduler
    Scheduler["UserScheduler\n(@Scheduled Weekly)"]:::service
    click Scheduler "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/java/com/sathwikhbhat/journalapp/scheduler/UserScheduler.java"

    %% Resources
    ApplicationYML["application.yml\n(Config)"]:::external
    click ApplicationYML "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/resources/application.yml"
    Logback["logback.xml\n(Logging)"]:::external
    click Logback "https://github.com/sathwikhbhat/journal-app/blob/main/src/main/resources/logback.xml"

    %% Application Structure
    App --> SecConfig
    App --> Swagger
    App --> ExceptionHandler
    App --> JwtFilter
    App --> PublicCtrl
    App --> UserCtrl
    App --> JournalCtrl
    App --> AdminCtrl
    App --> Scheduler

    %% Auth Flow
    User --> PublicCtrl
    PublicCtrl --> UserService
    UserService --> JwtUtil
    JwtUtil --> PublicCtrl
    PublicCtrl --> User["JWT Token"]:::external

    %% Protected Requests
    User --> JwtFilter
    JwtFilter -->|"validates"| UserDetailsService
    JwtFilter -->|"on success"| UserCtrl
    JwtFilter -->|"on success"| JournalCtrl
    JwtFilter -->|"on success"| AdminCtrl

    UserCtrl --> UserService
    UserService --> UserRepo
    UserRepo --> UserEntity

    JournalCtrl --> JournalService
    JournalService --> SentimentEnum
    JournalService --> JournalRepo
    JournalRepo --> JournalEntity

    AdminCtrl --> UserService
    AdminCtrl --> JournalService

    %% Scheduler Email Flow
    Scheduler --> EmailService
    EmailService --> JournalService
    EmailService --> UserService
    EmailService --> Gmail

    %% Data Store
    UserRepo --> MongoDB
    UserRepoImpl --> MongoDB
    JournalRepo --> MongoDB

    %% Resources Links
    ApplicationYML --> MongoDB
    ApplicationYML --> Gmail

    %% Styles
    classDef controller fill:#D8B4FE,stroke:#7C3AED,color:#000
    classDef service fill:#FED7AA,stroke:#C2410C,color:#000
    classDef security fill:#FCA5A5,stroke:#B91C1C,color:#000
    classDef data fill:#A7F3D0,stroke:#047857,color:#000
    classDef external fill:#BFDBFE,stroke:#1E3A8A,color:#000
    classDef app fill:#E0E7FF,stroke:#4338CA,color:#000
```
