How varmasahil04/inkwell works
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: UserService.java User services · SpringSecurity.java JWT security · PublicController.java Public account API · WeatherService.java Weather lookup
Components 27
Browser application
- SPA shell
src/main/resources/static/js/app.js - Route dispatch
src/main/resources/static/js/router.js - User views
src/main/resources/static/js/views - API client
src/main/resources/static/js/api.js - Token state
src/main/resources/static/js/auth.js
Identity and access
- JWT security
src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java - JWT filter
src/main/java/net/engineeringdigest/journalApp/Filter/JwtFilter.java - Public account API
src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java - User services
src/main/java/net/engineeringdigest/journalApp/Service/UserService.java - Admin API
src/main/java/net/engineeringdigest/journalApp/controller/Admin.java
Journal and analytics
- Journal API
src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java - Entry services
src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java - Sentiment scheduler
src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java - Sentiment analysis
src/main/java/net/engineeringdigest/journalApp/Service/SentimentAnalysisService.java
Data and integrations
- Profile and weather API
src/main/java/net/engineeringdigest/journalApp/controller/UserController.java - Weather lookup
src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java - Metadata cache
src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java - Redis cache service
src/main/java/net/engineeringdigest/journalApp/Service/RedisService.java - Email service
src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java - User repository
src/main/java/net/engineeringdigest/journalApp/repository/UserRepo.java - Entry repository
src/main/java/net/engineeringdigest/journalApp/repository/JournalEntryRepo.java - Config repository
src/main/java/net/engineeringdigest/journalApp/repository/ConfigJournalAppRepo.java
Other components
- Journal user
- Brevo email gateway
- MongoDB
- Redis
- Weather API
Connections 31
- Journal user → SPA shell: uses
- SPA shell → Route dispatch: starts
- Route dispatch → User views: dispatches
src/main/resources/static/js/router.js - User views → API client: requests
src/main/resources/static/js/views/admin.js - API client → Token state: reads token
src/main/resources/static/js/api.js - API client → JWT security: calls REST API
- JWT security → JWT filter: registers filter
src/main/java/net/engineeringdigest/journalApp/config/SpringSecurity.java - JWT security → Public account API: routes requests
- Public account API → User services: registers users
src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java - Public account API → User repository: looks up and saves
src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java - Public account API → Brevo email gateway: sends reset email
src/main/java/net/engineeringdigest/journalApp/controller/PublicController.java - User services → User repository: persists users
src/main/java/net/engineeringdigest/journalApp/Service/UserService.java - JWT security → Journal API: protects routes
- Journal API → Entry services: manages entries
src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java - Journal API → User services: loads owner
src/main/java/net/engineeringdigest/journalApp/controller/JournalEntryControllerV2.java - Entry services → Entry repository: reads and writes
src/main/java/net/engineeringdigest/journalApp/Service/JournalEntryServices.java - Sentiment scheduler → Sentiment analysis: analyzes entries
src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java - Sentiment scheduler → User repository: loads users
src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java - Sentiment scheduler → Email service: sends summaries
src/main/java/net/engineeringdigest/journalApp/scheduler/UserScheduler.java - Email service → Brevo email gateway: delegates delivery
src/main/java/net/engineeringdigest/journalApp/Service/EmailService.java - Admin API → User services: administers accounts
- Profile and weather API → User services: loads profile
src/main/java/net/engineeringdigest/journalApp/controller/UserController.java - Profile and weather API → Weather lookup: gets weather
src/main/java/net/engineeringdigest/journalApp/controller/UserController.java - Weather lookup → Redis cache service: checks and caches
src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java - Redis cache service → Redis: reads and writes
- Weather lookup → Metadata cache: reads endpoint config
src/main/java/net/engineeringdigest/journalApp/Service/WeatherService.java - Weather lookup → Weather API: fetches forecast
- Metadata cache → Config repository: loads configuration
src/main/java/net/engineeringdigest/journalApp/cache/AppCache.java - User repository → MongoDB: stores users
- Entry repository → MongoDB: stores entries
- Config repository → MongoDB: stores config