How bassemhalim/memedb works
Project Type and Purpose
• This is “MemeHub,” a full‐stack, microservice‐based meme‐sharing platform.
• Frontend: Next.js (React) handles UI, SSR, i18n (ar/en), meme generation, upload/search pages.
• Backend: Go microservices exposed via REST (Gateway) and gRPC (MemeService).
• Data store: PostgreSQL for metadata; local file system for image blobs.
• Auxiliary services: rate‐limiter, queue, moderator for content filtering.
High‐Level Architectural Components
a. Client (Next.js)
• Docker container with the client/ directory.
• Routes: /generator, /meme/[id], /search, /admin.
• UI components: MemeGenerator, UploadMemeForm, MemeCard, etc.
• Localization module (i18n).
b. API Gateway (Go)
• Docker container built from services/gateway.Dockerfile.
• Exposes REST endpoints (/api/memes, /api/search, /api/admin).
• Internal modules:
• auth (JWT/session, internal/auth)
• rate‐limiter (IP + token bucket under services/rate-limiter)
• validation middleware (internal/middleware)
• fileserver (internal/fileserver) serves static images from shared volume
• gRPC client (internal/server/grpc_client.go) to MemeService.
• Caching layer (TODO).
c. MemeService (Go)
• Docker container from services/meme-service.Dockerfile.
• gRPC server defined by services/proto/memeService/meme.proto.
• Handles DB CRUD for memes, stores metadata in PostgreSQL, writes image files to mounted volume.
• Internal packages: db (config + queries), server (gRPC handlers), utils.
d. PostgreSQL
• Container from services/postgres.Dockerfile.
• Initialized with init.sql.
• Stores tables for memes, tags, users (future).
e. Shared File Storage
• Mounted volume accessible by MemeService (for writes) and Gateway (for reads).
• Stores raw image files and generated meme variants.
f. Auxiliary Services (future or library form)
• Moderator (services/moderator/moderator.go): CLI or service for offensive‐content scanning (OCR, image analysis).
• Queue (services/queue/queue.go): for async tasks (e.g., thumbnail generation).
• Rate Limiter modules under services/rate-limiter.
g. Protocol Definitions
• services/proto/memeService: central gRPC contract shared by Gateway and MemeService.
Interactions & Data Flow
1. User → Browser: UI loaded (SSR/static)
2. Browser → Gateway: HTTP(S) REST calls (upload, search, delete, update)
3. Gateway → Rate Limiter & Auth → Validation → Caching lookup
4. Gateway → MemeService: gRPC request/response
5. MemeService → PostgreSQL: SQL queries
6. MemeService → File System: write/read image files
7. Gateway → File System: serve images to client
8. Optional: Gateway enqueues tasks to Queue or invokes Moderator for content filtering.
Architectural Patterns & Principles
• Microservice decomposition: each service has single responsibility.
• API Gateway pattern: central entry to enforce auth, rate limiting, validation.
• Internal modularization in Go via /cmd, /internal.
• Next.js App Router with localized dynamic routes.
• Contract‐first design: gRPC proto for internal comms.
• Docker Compose orchestration sample under services/docker-compose.yml.sample.