How jaiscode/fuel-marking works
Fuel Marking System tracks rum containers and truck markings across offline-capable marking sites and head office. At a site, staff sign in, manage shifts and seals, then register, dose, dispense and verify trucks; warehouse, transfer, incident and stock-count work support custody tracking. The desktop syncs site records to the central backend, which provides web reporting and master-data administration and sends master data back to sites. The README documents these system-level flows; sampled source supports selected implementation details, but unsampled modules are represented at subsystem level.
Main entry points: ui Desktop UI · SyncController.java Site sync API · app.routes.ts Angular web app · MarkingService.java Truck marking
Components 22
Marking-site desktop
- Desktop UI
src/main/java/org/jai/fuelmarking/ui - PIN sign-in
src/main/java/org/jai/fuelmarking/service/AuthService.java - Truck marking
src/main/java/org/jai/fuelmarking/service/MarkingService.java - Container custody
src/main/java/org/jai/fuelmarking/service/ContainerService.java - Site operations
src/main/java/org/jai/fuelmarking/service - Scale interface
src/main/java/org/jai/fuelmarking/hardware - Site sync agent
src/main/java/org/jai/fuelmarking/sync/SyncAgent.java
Central services
- Central backend
backend/src/main/java/org/jai/fuelmarking/central - Site sync API
backend/src/main/java/org/jai/fuelmarking/central/sync/SyncController.java - Master-data admin
backend/src/main/java/org/jai/fuelmarking/central/master/AdminController.java - Master-data outbox
backend/src/main/java/org/jai/fuelmarking/central/master/MasterDataOutbox.java - Reports and reads
backend/src/main/java/org/jai/fuelmarking/central/web/ReadController.java
Head-office web
- Angular web app
web/src/app/app.routes.ts - OIDC sign-in
web/src/app/core/auth.service.ts - API client
web/src/app/core/api.service.ts
Persistence and messaging
- Site sync outbox
src/main/java/org/jai/fuelmarking/dao/Outbox.java - Site PostgreSQL
src/main/java/org/jai/fuelmarking/config/Tx.java - Central PostgreSQL
backend/src/main/java/org/jai/fuelmarking/central/sync/SyncService.java - Kafka topic
Other components
- Site staff
- Head-office user
- OIDC provider
Connections 23
- Site staff → Desktop UI: uses
README.md - Desktop UI → PIN sign-in: signs in
README.md - Desktop UI → Truck marking: runs workflow
README.md - Truck marking → Container custody: tracks custody
- Desktop UI → Site operations: records activity
README.md - Desktop UI → Scale interface: weighs
- Truck marking → Site PostgreSQL: persists
src/main/java/org/jai/fuelmarking/service/MarkingService.java - Site operations → Site PostgreSQL: persists
src/main/java/org/jai/fuelmarking/service/AuthService.java - Site PostgreSQL → Site sync outbox: queues changes
- Site sync outbox → Site sync agent: feeds
- Site sync agent → Site sync API: pushes records
README.md - Site sync API → Central PostgreSQL: stores and serves
backend/src/main/java/org/jai/fuelmarking/central/sync/SyncController.java - Site sync API → Site sync agent: returns transfers
README.md - Site sync API → Kafka topic: receives master data
README.md - Master-data admin → Master-data outbox: queues updates
backend/src/main/java/org/jai/fuelmarking/central/master/AdminController.java - Master-data outbox → Kafka topic: publishes
README.md - Head-office user → Angular web app: uses
README.md - Angular web app → OIDC sign-in: authenticates
web/src/app/app.routes.ts - OIDC sign-in → OIDC provider: signs in with
- Angular web app → API client: requests data
- API client → Reports and reads: calls
- Reports and reads → Central PostgreSQL: reads
- Angular web app → Master-data admin: maintains master data
README.md