How srinivas26k/poll-webapp works
Project type and purpose
• This is a full-stack, real-time quiz application.
• Frontend: React + TypeScript single-page app (Host & Participant roles).
• Backend: Node/Express + TypeScript REST API for session and quiz management.
• Real-time layer: Pusher (pub/sub) for broadcasting transcripts and quiz events.
• AI integration: Generates polls/quizzes from transcripts every five minutes.
Main components
a. Frontend – Host UI
• React component tree under src/components/Host
• Uses Web Speech API (speechRecognition.ts) to capture audio and produce transcripts
• Sends transcripts to backend or directly to Pusher via pusherService.ts
• Controls session lifecycle (create/join/end) via sessionController endpoints
b. Frontend – Participant UI
• React component tree under src/components/Participant
• Subscribes to real-time channels for live transcripts and quiz events
• Renders transcripts in real time and displays polls/quizzes
c. Backend – Express Server
• Entry point: server/server.ts (or server.js)
• Routes: server/routes/index.ts
• Controllers:
– sessionController.ts (create/join sessions, session state)
– quizController.ts (trigger quiz generation, receive answers)
• AI Service (could live in backend or client as aiService.ts) that uses an external NLP/ML API to create questions
• No persistent database shown (in-memory session store implied)
d. Real-time Pub/Sub Layer
• Pusher (via pusherService.ts) as external cloud service
• Channels for “session-<id>-transcripts” and “session-<id>-quizzes”
e. External APIs
• Web Speech API (browser) for transcription
• AI provider (OpenAI or custom) for quiz generation
Relationships and data flows
1. Host clicks “Start Session” → Frontend calls HTTP POST /sessions → Backend creates session, returns sessionId.
2. Host’s browser activates Web Speech API → transcripts fed to speechRecognition.ts → forwarded via pusherService or HTTP POST /sessions/:id/transcript → Backend receives transcript.
3. Backend broadcasts transcript over Pusher channel → Participant UIs receive real-time updates.
4. Every 5 minutes a timer triggers quizController → fetches accumulated transcripts → calls AI Service → generates poll questions → broadcasts quiz event via Pusher.
5. Participants answer quizzes → answers sent back via HTTP POST /quizzes/:id/answers → quizController records/rates responses → may broadcast results.
Architectural patterns and design principles
• Pub/Sub for real-time communication (decouples sender/receivers)
• MVC-style on backend (routes → controllers → service logic)
• Single-page app on frontend with component separation (Host vs Participant)
• Periodic batch processing for quiz generation (timers + AI service)
• Components: Host UI, Participant UI, Express API (SessionController, QuizController), AI Service, Pusher
• “start session” HTTP call
• “send transcript” flow
• “broadcast transcript” flow
• “generate quiz” flow
• “answer quiz” flow