How ayonpaul8906/zencue works
Project Type & Purpose
• This is a full-stack web application (“ZenCue”) that combines a React/Vite/Tailwind frontend, a Flask backend, AI multimodal processing (via Groq APIs), Firebase for auth & datastore, and OnchainKit (Base) for subscription payments.
• Purpose: Provide neurodivergent children with smart text/image/audio summarization, voice/chat AI, focus tools, plus secure on-chain subscription management.
File Structure Highlights
• Top-level:
• backend/ – Flask service (app.py, requirements.txt, Procfile)
• frontend/ – React/Vite SPA (TypeScript, Tailwind, Radix UI, many UI components)
• frontend/src/lib & hooks: wrappers for Firebase auth, Groq API calls, subscription logic
• Config files: Vite, Tailwind, eslint, tsconfig, vercel.json (frontend deploy), Procfile (backend deploy)
• No monorepo tooling; frontend and backend are separate deployables.
README Insights
• AI features: text/image understanding, chat with TTS via Groq
• Auth & data via Firebase (Firestore + Auth)
• On-chain payments & subscription via Base (SepholiaETH)
• Frontend hosted on Vercel; backend likely on Heroku or similar (Procfile present)
a. Frontend (Browser/Client)
• React App (Vite)
• UI Layer (Radix UI components)
• Auth Context & Routing
• Groq API wrappers / subscription hooks / Firebase SDK
• OnchainKit wallet integration
b. Backend (Flask API)
• REST endpoints: /summarize, /vision-explain, /chat, /tts
• Groq API clients (text, vision, audio)
• Firebase Admin (optional) for any server-side DB ops
c. Database & Auth
• Firebase Authentication
• Firestore (user profiles, subscription status, usage logs)
d. External Services
• Groq Multimodal AI APIs
• OnchainKit (Base) & Ethereum Sepolia
e. Hosting/Deployment
• Frontend → Vercel
• Backend → Heroku/AWS/GCP (Procfile implies Heroku)
Relationships & Data Flow
• User → Frontend (UI interactions, NFT wallet popups via OnchainKit)
• Frontend → Firebase Auth (login/signup)
• Frontend → Flask API over HTTPS
• For text/image summarization and voice chat
• Flask API → Groq APIs (multimodal calls)
• Frontend ↔ Firestore (fetch/save profile, subscription data)
• Frontend → OnchainKit → Base blockchain (manage subscriptions)
• All traffic secured over TLS
Architectural Patterns & Principles
• Separation of concerns: UI vs client-side logic vs backend services
• Component-driven UI (Radix + Tailwind + custom components)
• Hook-based logic for data & side-effects (React Hooks)
• Externalizing secrets/config via .env, aligning with 12-factor app
• Micro-service style: small Flask API for AI features, distinct from client