How greywarden07/freshtrack works
Project type and purpose
• FreshTrack is a client-heavy single-page application (SPA) built with React.
• It leverages Firebase as a Backend-as-a-Service (BaaS) for Authentication, Firestore (database), and Storage.
• It also uses Tesseract.js (in-browser OCR) and an external AI service (Google Gemini) for recipe suggestions.
File structure
• Top-level: package.json / lock files, public/ (static assets), src/ (all React source).
• src/components/: UI components (Dashboard, FileUpload, HomePage, etc.).
• src/contexts/authContext/: React Context for Auth state and methods.
• src/services/: Plain-JS modules encapsulating calls to Firestore, Storage, OCR, notifications, recipes, mock data.
• src/firebase/: Firebase initialization and wrappers (auth.js, groceries.js, users.js, serviceSwitcher.js).
README for architectural insights
• Tech stack confirms React, Material UI, Framer Motion, React Router.
• Firebase is the sole backend.
• Receipt scanning is done client-side via Tesseract.js.
• Recipe suggestions can call Google Gemini AI via REST.
Main components & their relationships
a. Client (Browser) – hosts the React SPA.
b. React App
• UI Layer: src/components – renders pages, forms, dashboards.
• Context Layer: src/contexts/authContext – manages user session and injects Auth methods.
• Service Layer: src/services/*.js – encapsulates business logic and network calls.
• Firebase Layer: src/firebase/*.js – initializes Firebase SDKs and exposes wrappers.
• OCR Engine: Tesseract.js (runs in browser)
c. External Services
• Firebase Authentication
• Firebase Firestore (database)
• Firebase Storage (receipt images)
• Google Gemini AI API (recipe suggestions)
How data flows
• User action (e.g., “Upload Receipt”)
→ UI Component (FileUpload.js)
→ Service Layer (ocr.js → Tesseract.js for text extraction)
→ Service Layer (storage.js uploads original image to Firebase Storage)
→ Service Layer (expirySearch.js or groceries.js) writes parsed items + expiry dates to Firestore
→ Dashboard component subscribes (via Firestore onSnapshot) to display upcoming expiries
→ Recipe component calls recipe.js, which may call Google Gemini
Architectural patterns & design principles
• Separation of concerns: UI vs. context vs. services vs. external SDKs
• Single source of truth for auth via React Context
• Encapsulated data-access layer (services/*.js + firebase/*.js)
• Client-side rendering & processing (OCR)
• Event-driven UI updates via Firestore real-time subscriptions
Final advice
• Be thorough: separate each React layer and each external dependency.
• Don’t overcomplicate: focus on the 4 layers (UI, Context, Services, External) and their main interactions.