# varmasahil04/inkwell architecture

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

- Interactive diagram: https://gitdiagram.com/varmasahil04/inkwell
- Repository: https://github.com/varmasahil04/inkwell

## Overview

Inkwell is a journaling and analytics platform with a browser SPA and Spring REST backend. The primary workflow is account access, authenticated journal management, and profile/dashboard data; a separate scheduled workflow summarizes sentiment and emails users. The graph also preserves password recovery, administration, weather, and caching. Some subsystem relationships come from the README or SOURCE INDEX rather than inspected implementation; uncertain links are omitted.

Main entry points: [`src/main/java/net/engineeringdigest/journalApp/Service/UserService.java`](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/UserService.java) (User services), [`src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java`](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java) (JWT security), [`src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java`](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java) (Public account API), [`src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java`](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java) (Weather lookup)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Browser application"]
  node_spa["SPA shell<br/>[app.js]"]
  node_router["Route dispatch<br/>[router.js]"]
  node_views["User views"]
  node_api["API client<br/>[api.js]"]
  node_auth["Token state<br/>[auth.js]"]
end

subgraph group_access["Identity and access"]
  node_security["JWT security"]
  node_jwtfilter["JWT filter<br/>[JwtFilter.java]"]
  node_publicapi["Public account API"]
  node_users["User services<br/>[UserService.java]"]
  node_admin["Admin API<br/>[Admin.java]"]
end

subgraph group_journal["Journal and analytics"]
  node_journalapi["Journal API"]
  node_journalservice["Entry services"]
  node_scheduler["Sentiment scheduler<br/>[UserScheduler.java]"]
  node_sentiment["Sentiment analysis"]
end

subgraph group_platform["Data and integrations"]
  node_usercontroller["Profile and weather API"]
  node_weather["Weather lookup"]
  node_appcache["Metadata cache<br/>[AppCache.java]"]
  node_redis["Redis cache service<br/>[RedisService.java]"]
  node_email["Email service<br/>[EmailService.java]"]
  node_userrepo[("User repository<br/>[UserRepo.java]")]
  node_entryrepo[("Entry repository")]
  node_configrepo[("Config repository")]
end

node_browser(("Journal user"))
node_brevo{{"Brevo email gateway"}}
node_mongo[("MongoDB")]
node_redisstore[("Redis")]
node_weatherapi{{"Weather API"}}

node_browser -->|"uses"| node_spa
node_spa -.->|"starts"| node_router
node_router -->|"dispatches"| node_views
node_views -.->|"requests"| node_api
node_api -->|"reads token"| node_auth
node_api -->|"calls REST API"| node_security
node_security -->|"registers filter"| node_jwtfilter
node_security -->|"routes requests"| node_publicapi
node_publicapi -->|"registers users"| node_users
node_publicapi -->|"looks up and saves"| node_userrepo
node_publicapi -->|"sends reset email"| node_brevo
node_users -->|"persists users"| node_userrepo
node_security -->|"protects routes"| node_journalapi
node_journalapi -->|"manages entries"| node_journalservice
node_journalapi -->|"loads owner"| node_users
node_journalservice -->|"reads and writes"| node_entryrepo
node_scheduler -->|"analyzes entries"| node_sentiment
node_scheduler -->|"loads users"| node_userrepo
node_scheduler -->|"sends summaries"| node_email
node_email -->|"delegates delivery"| node_brevo
node_admin -.->|"administers accounts"| node_users
node_usercontroller -->|"loads profile"| node_users
node_usercontroller -->|"gets weather"| node_weather
node_weather -->|"checks and caches"| node_redis
node_redis -.->|"reads and writes"| node_redisstore
node_weather -->|"reads endpoint config"| node_appcache
node_weather -->|"fetches forecast"| node_weatherapi
node_appcache -->|"loads configuration"| node_configrepo
node_userrepo -->|"stores users"| node_mongo
node_entryrepo -->|"stores entries"| node_mongo
node_configrepo -.->|"stores config"| node_mongo

click node_spa "https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/app.js"
click node_router "https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/router.js"
click node_views "https://github.com/varmasahil04/inkwell/tree/main/src/main/resources/static/js/views"
click node_api "https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/api.js"
click node_auth "https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/auth.js"
click node_security "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java"
click node_jwtfilter "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Filter/JwtFilter.java"
click node_publicapi "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java"
click node_users "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/UserService.java"
click node_journalapi "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java"
click node_journalservice "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java"
click node_scheduler "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java"
click node_sentiment "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/SentimentAnalysisService.java"
click node_admin "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/Admin.java"
click node_usercontroller "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/UserController.java"
click node_weather "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java"
click node_appcache "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java"
click node_redis "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/RedisService.java"
click node_email "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java"
click node_userrepo "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/UserRepo.java"
click node_entryrepo "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/JournalEntryRepo.java"
click node_configrepo "https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/ConfigJournalAppRepo.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_spa,node_router,node_views,node_api,node_auth,node_browser toneBlue
class node_security,node_jwtfilter,node_publicapi,node_users,node_admin,node_mongo,node_redisstore toneAmber
class node_journalapi,node_journalservice,node_scheduler,node_sentiment,node_weatherapi toneMint
class node_usercontroller,node_weather,node_appcache,node_redis,node_email,node_userrepo,node_entryrepo,node_configrepo toneRose
class node_brevo toneIndigo
```

## Components

### Browser application

- [SPA shell](https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/app.js): `src/main/resources/static/js/app.js`
- [Route dispatch](https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/router.js): `src/main/resources/static/js/router.js`
- [User views](https://github.com/varmasahil04/inkwell/tree/main/src/main/resources/static/js/views): `src/main/resources/static/js/views`
- [API client](https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/api.js): `src/main/resources/static/js/api.js`
- [Token state](https://github.com/varmasahil04/inkwell/blob/main/src/main/resources/static/js/auth.js): `src/main/resources/static/js/auth.js`

### Identity and access

- [JWT security](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java): `src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java`
- [JWT filter](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Filter/JwtFilter.java): `src/main/java/net/engineeringdigest/journalApp/Filter/JwtFilter.java`
- [Public account API](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java): `src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java`
- [User services](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/UserService.java): `src/main/java/net/engineeringdigest/journalApp/Service/UserService.java`
- [Admin API](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/Admin.java): `src/main/java/net/engineeringdigest/journalApp/controller/Admin.java`

### Journal and analytics

- [Journal API](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java): `src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java`
- [Entry services](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java): `src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java`
- [Sentiment scheduler](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java): `src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java`
- [Sentiment analysis](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/SentimentAnalysisService.java): `src/main/java/net/engineeringdigest/journalApp/Service/SentimentAnalysisService.java`

### Data and integrations

- [Profile and weather API](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/controller/UserController.java): `src/main/java/net/engineeringdigest/journalApp/controller/UserController.java`
- [Weather lookup](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java): `src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java`
- [Metadata cache](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java): `src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java`
- [Redis cache service](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/RedisService.java): `src/main/java/net/engineeringdigest/journalApp/Service/RedisService.java`
- [Email service](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java): `src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java`
- [User repository](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/UserRepo.java): `src/main/java/net/engineeringdigest/journalApp/repository/UserRepo.java`
- [Entry repository](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/JournalEntryRepo.java): `src/main/java/net/engineeringdigest/journalApp/repository/JournalEntryRepo.java`
- [Config repository](https://github.com/varmasahil04/inkwell/blob/main/src/main/java/net/engineeringdigest/journalApp/repository/ConfigJournalAppRepo.java): `src/main/java/net/engineeringdigest/journalApp/repository/ConfigJournalAppRepo.java`

### Other components

- **Journal user**
- **Brevo email gateway**
- **MongoDB**
- **Redis**
- **Weather API**

## Connections

- Journal user → SPA shell: uses
- SPA shell → Route dispatch: starts
- Route dispatch → User views: dispatches (evidence: `src/main/resources/static/js/router.js`)
- User views → API client: requests (evidence: `src/main/resources/static/js/views/admin.js`)
- API client → Token state: reads token (evidence: `src/main/resources/static/js/api.js`)
- API client → JWT security: calls REST API
- JWT security → JWT filter: registers filter (evidence: `src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java`)
- JWT security → Public account API: routes requests
- Public account API → User services: registers users (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java`)
- Public account API → User repository: looks up and saves (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java`)
- Public account API → Brevo email gateway: sends reset email (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java`)
- User services → User repository: persists users (evidence: `src/main/java/net/engineeringdigest/journalApp/Service/UserService.java`)
- JWT security → Journal API: protects routes
- Journal API → Entry services: manages entries (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java`)
- Journal API → User services: loads owner (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java`)
- Entry services → Entry repository: reads and writes (evidence: `src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java`)
- Sentiment scheduler → Sentiment analysis: analyzes entries (evidence: `src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java`)
- Sentiment scheduler → User repository: loads users (evidence: `src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java`)
- Sentiment scheduler → Email service: sends summaries (evidence: `src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java`)
- Email service → Brevo email gateway: delegates delivery (evidence: `src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java`)
- Admin API → User services: administers accounts
- Profile and weather API → User services: loads profile (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/UserController.java`)
- Profile and weather API → Weather lookup: gets weather (evidence: `src/main/java/net/engineeringdigest/journalApp/controller/UserController.java`)
- Weather lookup → Redis cache service: checks and caches (evidence: `src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java`)
- Redis cache service → Redis: reads and writes
- Weather lookup → Metadata cache: reads endpoint config (evidence: `src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java`)
- Weather lookup → Weather API: fetches forecast
- Metadata cache → Config repository: loads configuration (evidence: `src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java`)
- User repository → MongoDB: stores users
- Entry repository → MongoDB: stores entries
- Config repository → MongoDB: stores config
