How flashhhhh/vcs-sms works
Project type and purpose
• This project, “VCS-SMS,” is a Go-based microservices system (with a bit of Python orchestration via main.py).
• It provides user management (user_service), server administration (server_administration_service), email notifications (mail_service), health‐checking capabilities (healthcheck_service), and a fake server simulator (fake_server_service).
• Each service exposes REST and/or gRPC APIs, owns its own datastore (Postgres, Redis, Elasticsearch, etc.), and communicates via gRPC or Kafka.
File structure
• Top-level services:
• fake_server_service
• healthcheck_service
• mail_service
• server_administration_service
• user_service
• Common patterns:
• cmd/ – entry points (REST, gRPC, Kafka)
• api/ – HTTP middlewares & routes
• infrastructure/ – adapters for databases, caches, brokers, gRPC servers/clients
• internal/ – service/business logic, handlers, repositories, DTOs/domain models
• proto/pb – Protocol Buffer definitions & stubs
• deployments/docker & kubernetes – containerization artifacts
• Shared artifacts: docker-compose.yml (orchestration), OpenAPI specs in docs/, swagger-config.yaml
Key architectural characteristics
• Microservices, each isolated in its own Git module, container, and deployment.
• Polyglot inter-service comms: HTTP+REST for external API, gRPC for high-performant internal RPC, Kafka for eventing.
• Each service typically uses Postgres for primary storage, Redis for caching or pub/sub, and Elasticsearch for search (server_administration).
• Healthcheck service polls or receives health-status data via gRPC.