How reltadev/github-assistant works
Main Components Identification
a) Frontend Layer (client-poc):
• Next.js application
• React components
• UI components (shadcn/ui)
• Flow visualization components
• API routes
b) Backend Layer (server-poc):
• FastAPI server
• Data pipelines
• Semantic layer
• Models
c) External Services:
• GitHub API
• OpenAI API
• PostgreSQL Database
┌─ Client Layer ─────────────────────┐
• Next.js + React │
• ┌─────────────┐ ┌────────────┐ │
• UI/Flow │ │ API Routes│ │
• ┘ └────────────┘ │
• ┬────────────┬───────┘
┌───────────────▼────────────▼───────┐
• Server Layer │
• ┌─────────────┐ ┌────────────┐ │
• FastAPI Server│ │ Relta │ │
• ┘ └────────────┘ │
• ┌─────────────┐ ┌────────────┐ │
• Data Pipeline│ │ Semantic │ │
• (DLT) │ │ Layer │ │
• ┘ └────────────┘ │
• ┬────────────┬──────────┘
┌───────────▼─┐ ┌──────▼───────┐
• GitHub API │ │ PostgreSQL DB │
• ┘ └──────────────┘
Important Flows to Highlight
a) Data Ingestion Flow:
• GitHub API → Data Pipeline → PostgreSQL
• How the DLT pipeline processes GitHub data
b) Query Flow:
• Frontend → API Routes → FastAPI Server → Relta → Semantic Layer → PostgreSQL
• OpenAI integration for natural language processing
Key Architectural Patterns to Emphasize
• Client-Server architecture
• API-first design
• ETL pipeline pattern
• Semantic layer abstraction
• Microservices-like separation of concerns
Infrastructure Components
AWS infrastructure components from the infra directory:
• ECS (Elastic Container Service)
• RDS (Relational Database Service)
• Networking components
Additional Details
• Authentication flow (SSO callback)
• Environment configurations
• Component dependencies
• Deployment boundaries