How oyezaheer/imaginify works
Project type and purpose
• This is a full-stack SaaS web application (“An AI SaaS Platform”) built with Next.js (App Router), TypeScript, MongoDB, Clerk for authentication, Cloudinary for media hosting, Stripe for payments, Shadcn/TailwindCSS for UI components.
• It offers user authentication, credit‐based image transformations, transaction tracking, and webhook integrations.
File structure
• app/ (Next.js App Router)
• (auth) subfolder: sign-in, sign-up pages (Clerk)
• (root) subfolder: public pages (credits, profile, transformations CRUD)
• app/api/: serverless API routes for Clerk & Stripe webhooks
• layout.tsx, globals.css: global layouts & styles
• components/ & components/ui/: shared UI/UX building blocks (Shadcn/Tailwind)
• lib/
• actions/: business logic (image, transaction, user)
• database/: Mongoose setup & models (User, Image, Transaction)
• utils.ts: helper functions
• Configs: next.config.mjs, tsconfig.json, tailwind.config.ts, postcss.config.js
• middleware.ts: Next.js middleware (e.g., auth guards)
README
• Confirms tech stack (Next.js, TypeScript, MongoDB, Clerk, Cloudinary, Stripe, Shadcn, TailwindCSS)
• Basic setup and run instructions
a. Main Components
• Client (Browser/mobile)
• Frontend (Next.js App)
• Auth Service (Clerk)
• Backend/API Layer (Next.js API routes + lib/actions)
• Database (MongoDB via Mongoose)
• Media Storage (Cloudinary)
• Payment Service (Stripe)
• External AI engine (if any; implicit)
b. Relationships & Interactions
1. User → Browser UI → Next.js pages/components
2. UI triggers API calls (REST/HTTP) to:
• Authentication (Clerk SDK)
• CRUD operations via lib/actions (user, image, transactions)
3. API layer → MongoDB (read/write models)
4. API layer → Cloudinary (upload/retrieve images)
5. API layer → Stripe (charge user credits, via payment intents)
6. Stripe & Clerk send webhooks → /app/api/webhooks/stripe & /clerk/route.ts → update DB
c. Architectural Patterns & Principles
• Separation of Concerns:
• UI vs. Business Logic (components vs. lib/actions)
• Serverless functions (Next.js API) vs. Persistent DB
• Modular Components: Shadcn UI primitives + shared components
• Middleware: auth guard, routing logic
• MVC-like: Routes → Controllers (actions) → Models
d. Key Technologies & Frameworks
• Next.js (App Router, server-side rendering, API routes)
• TypeScript (types/tsconfig)
• MongoDB + Mongoose (lib/database/models)
• Clerk (auth)
• Cloudinary (media)
• Stripe (payments)
• TailwindCSS & Shadcn (styling/UI)