How ivennjy/supershapeadmin-cap works
Project Type and Purpose
• This is a full-stack, serverless admin dashboard (React/Vite frontend + Netlify Functions + Firebase backend).
• Purpose: Allow Admin and Superadmin users to manage classes, users, announcements, credits, etc.
File Structure
• Top-level folders:
– backend/ (firebaseConfig.js)
– netlify/functions/ (createUser.js, notifyWaitingList.js)
– public/ & image samples (static assets)
– src/ (React code: App.jsx, components/, pages/, utils/)
• Config/build files:
– vite.config.js, package.json, .env.sample
• Deployment:
– Hosted on Netlify, uses serverless functions + static build
Architecture Overview
Components:
A. Client (React SPA)
• Runs in user’s browser
• Built with Vite, React, TailwindCSS
• Routes under src/pages (Admin vs Superadmin sections)
B. CDN & Static Hosting
• Netlify serves the built bundle (dist/) via a CDN
C. Serverless API Layer
• Netlify Functions:
• createUser.js – provisions new users in Firebase Auth/Firestore
• notifyWaitingList.js – sends notifications via Firebase (e.g., Firestore triggers or FCM)
D. Firebase Services
• Authentication (Auth Domain)
• Firestore Database (Projects, Users, Classes, Announcements, Credits)
• Cloud Storage (if storing files)
• Analytics / Messaging (optional via measurement ID)
Relationships & Data Flows
1. User opens browser → requests SPA from Netlify CDN.
2. React App initializes ← Firebase config (env vars loaded at runtime).
3. User logs in via Firebase Auth SDK → tokens returned.
4. ProtectedRoutes (src/components/protectedRoute.jsx) guard admin pages.
5. For CRUD operations:
• Option A: Direct Firestore calls from React (SDK).
• Option B: Invoke Netlify Function → function code uses firebaseConfig to operate on Firestore/Auth.
6. notifyWaitingList.js may be triggered by either API call or Firestore trigger (depending on implementation), sending emails or FCM notifications.
Architectural Patterns & Principles
• Client-side MVC-esque routing:
– src/pages for views, src/components for reusable widgets
• Serverless micro-endpoints:
– Each function implements a single responsibility (createUser, notifyWaitingList)
• Environment-based configuration:
– VITE_ prefixed vars injected at build time