How abhinks151/stockflow works
This is a StockFlow-style e-commerce backend split into an API gateway and user, inventory, order, and notification services. The main workflow is a customer request to create an order: the order service obtains user and product details, checks and deducts stock, persists the order, then publishes an event for confirmation email processing. User registration/login and profile operations, plus product catalog and stock management, are separate capabilities. Edges reflect shown imports and calls; cross-service transport and event-broker links are marked unverified where implementation excerpts were unavailable.
Main entry points: order.service.ts Order workflow · index.ts Gateway · user.service.ts User logic · product.service.ts Product logic
Components 32
API Gateway
- Gateway
api-gateway/src/index.ts - Gateway auth
api-gateway/src/middleware/auth.middleware.ts
User Service
- User routes
user-service/src/routes/user.routes.ts - User controller
user-service/src/controllers/user.controller.ts - User logic
user-service/src/services/user.service.ts - User repository
user-service/src/repositories/user.repository.ts - User model
user-service/src/models/user.model.ts - User database
user-service/src/config/db.ts - User gRPC
user-service/src/grpc/user.grpc.ts - User contracts
user-service/src/interfaces/user.interface.ts
Inventory Service
- Product routes
inventory-service/src/routes/product.routes.ts - Product controller
inventory-service/src/controllers/product.controller.ts - Product logic
inventory-service/src/services/product.service.ts - Product repository
inventory-service/src/repositories/product.repository.ts - Inventory database
inventory-service/src/config/db.ts - Inventory gRPC
inventory-service/src/grpc/inventory.grpc.ts - Product contracts
inventory-service/src/interfaces/product.interface.ts
Order Service
- Order routes
order-service/src/routes/order.routes.ts - Order controller
order-service/src/controllers/order.controller.ts - Order workflow
order-service/src/services/order.service.ts - Order repository
order-service/src/repositories/order.repository.ts - Order model
order-service/src/models/order.model.ts - Order database
order-service/src/config/db.ts - Order contracts
order-service/src/interfaces/order.interface.ts - Inventory client
order-service/src/clients/inventory.client.ts - User client
order-service/src/clients/user.client.ts - Event publisher
order-service/src/events/publisher.ts
Notifications
- Event consumer
notification-service/src/events/consumer.ts - Email service
notification-service/src/services/email.service.ts
Other components
- Customer
- Message broker
- SMTP service
Connections 35
- Customer → Gateway: sends requests
- Gateway → Gateway auth: uses auth
api-gateway/src/index.ts - Gateway → User routes: forwards requests
- Gateway → Product routes: forwards requests
- Gateway → Order routes: forwards requests
- User routes → User controller: dispatches
user-service/src/routes/user.routes.ts - User controller → User logic: invokes
user-service/src/controllers/user.controller.ts - User logic → User repository: reads and writes
user-service/src/services/user.service.ts - User repository → User model: uses model
user-service/src/repositories/user.repository.ts - User repository → User database: accesses
user-service/src/repositories/user.repository.ts - User model → User contracts: implements
user-service/src/models/user.model.ts - User logic → User contracts: uses contracts
user-service/src/services/user.service.ts - User gRPC → User logic: calls
- Product routes → Product controller: dispatches
inventory-service/src/routes/product.routes.ts - Product controller → Product logic: invokes
inventory-service/src/controllers/product.controller.ts - Product logic → Product repository: reads and writes
inventory-service/src/services/product.service.ts - Product repository → Inventory database: accesses
inventory-service/src/repositories/product.repository.ts - Product logic → Product contracts: uses contracts
inventory-service/src/services/product.service.ts - Inventory gRPC → Product logic: calls
inventory-service/src/grpc/inventory.grpc.ts - Order routes → Order controller: dispatches
order-service/src/routes/order.routes.ts - Order controller → Order workflow: invokes
order-service/src/controllers/order.controller.ts - Order workflow → User client: fetches user
order-service/src/services/order.service.ts - Order workflow → Inventory client: fetches product
order-service/src/services/order.service.ts - Order workflow → Inventory client: deducts stock
order-service/src/services/order.service.ts - User client → User gRPC: requests user
- Inventory client → Inventory gRPC: requests inventory
- Order workflow → Order repository: persists order
order-service/src/services/order.service.ts - Order workflow → Event publisher: publishes event
order-service/src/services/order.service.ts - Order repository → Order model: uses model
order-service/src/repositories/order.repository.ts - Order repository → Order database: accesses
- Order model → Order contracts: implements
order-service/src/models/order.model.ts - Event publisher → Message broker: publishes
- Message broker → Event consumer: delivers events
- Event consumer → Email service: requests email
notification-service/src/events/consumer.ts - Email service → SMTP service: sends mail
notification-service/src/services/email.service.ts