How nabarvn/chadgpt works
Project type and purpose
• This is a full-stack, serverless web app (“ChadGPT”) built with Next.js 13 (App Router) and TypeScript.
• Purpose: Provide a chat interface backed by OpenAI’s GPT models, with real-time streaming, persistent history (Firestore), Google OAuth authentication, and Redis-backed rate limiting.
File structure
• src/app – Next.js App Router directory containing:
– Page routes (src/app/page.tsx, src/app/chat/[id]/page.tsx)
– API routes (src/app/api/auth/[...nextauth]/route.ts, chats/route.ts, prompt/route.ts, models/route.ts)
– layout.tsx and globals.css for app-wide layout & styling
• src/components – UI building blocks (chat list, input, header, theme switcher, etc.)
• src/lib – Core business logic and wrappers: auth.ts, chat.ts, openai.ts (streaming), rate-limiter.ts, redis.ts, utils.ts
• src/firebase – Firebase client/server setup for Firestore & Admin SDK
• src/hooks – Custom React hooks for chat state, Firebase messages, scrolling, etc.
• src/config – Static configuration (system prompts, showcase content)
• Middleware & config files – src/middleware.ts (session, rate-limit middleware), next.config.js, Tailwind config, etc.
Key insights from README
• Frontend: Next.js + React + Tailwind CSS + Headless UI
• Auth: NextAuth.js with Google OAuth
• Database & Real-time: Firebase Cloud Firestore + react-firebase-hooks
• AI Streaming: OpenAI API via Vercel AI SDK
• Rate Limiting: Upstash Redis + @upstash/ratelimit
• Deployment target: serverless (e.g., Vercel)
Diagramming the architecture
a. Main components
• User’s browser (React UI)
• Next.js Frontend (App Router pages + React components)
• NextAuth.js (API route for OAuth sessions)
• Next.js API Routes (serverless functions handling /api/chats, /api/prompt, /api/models)
• Rate limiter (Upstash Redis via @upstash/ratelimit)
• OpenAI API (GPT streaming endpoints)
• Firestore (persistent, real-time chat collection)
b. Relationships & data flow
1. Browser ↔ Next.js Frontend (UI rendering, React state, hooks)
2. Frontend → NextAuth API route → Google OAuth → Session cookie
3. Frontend → API Routes (chats/prompt/models)
4. API Routes → Redis (check/increment rate limit)
5. API Routes → OpenAI API (request & stream GPT response)
6. API Routes → Firestore (write new messages)
7. Browser ←→ Firestore (subscribe to real-time updates via react-firebase-hooks)
c. Architectural patterns
• Serverless microservices: each API route is an isolated function
• Client/Server separation via Next.js App Router (React Server/Client components)
• Real-time pub/sub with Firestore
• Middleware enforcing auth & rate limits on every request
d. Technologies & frameworks
• Frontend: Next.js 13, React 18, TypeScript, Tailwind CSS
• Auth: NextAuth.js, Google OAuth Provider
• DB: Firebase Cloud Firestore, Firebase Admin SDK
• AI: OpenAI API, Vercel AI SDK
• Caching/Rate-limit: Upstash Redis, @upstash/ratelimit