Add metrics handling and update architecture documentation

[Adedayo-Data]

closes #45

Description

This PR introduces docs/ARCHITECTURE.md to provide a comprehensive technical overview of the StreamPay-Backend. It details the interaction between the HTTP API, background workers, and our data persistence layers (PostgreSQL & Redis), specifically focusing on the settlement data flow.

Key Changes

• New Documentation: Created docs/ARCHITECTURE.md.
• System Diagram: Added a Mermaid.js diagram illustrating the request lifecycle from the RPC client to the final settlement state.
• Component Breakdown: Defined roles for:
  • Express API: Entry point for HTTP requests.
  • Background Workers: Handling asynchronous settlement tasks.
  • Redis: Utilized for caching and message queuing.
  • RPC Clients: Interaction with blockchain providers.

Architecture Visualization

graph TD
    Client[RPC Client / Frontend] -->|HTTP| API[Express API]
    API -->|Read/Write| DB[(PostgreSQL)]
    API -->|Queue Job| Redis{Redis}
    Redis -->|Process| Worker[BacArchitecture overview: backend components diagramkground Worker]
    Worker -->|Execute| Settlement[Settlement Logic]
    Settlement -->|Query/Broadcast| Blockchain[Blockchain Node]
    Worker -->|Update Status| DB
    
    

Loading

[drips-wave]

@Adedayo-Data Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits