How pulkitporwal/snippeter works
Project type and purpose
• This is a full-stack, server-rendered web application built with Next.js and TypeScript.
• Primary goal: allow authenticated users to save, browse, edit, delete, and copy code snippets.
File structure
• Top-level framework: Next.js (next.config.mjs, src/app directory).
• Frontend UI components in src/GlobalComponents and src/app/** page and component folders.
• API routes under src/app/api (save-user, snippets).
• Data models in src/models (Snippet.ts, User.ts).
• Utility functions in src/utils (database connection, Gemini-based code generation).
• Middleware (src/middleware.ts) and context providers (src/app/context) for global state.
• Static assets in public (fonts, images).
Key insights from README
• Uses Clerk for user authentication and management.
• Tailwind CSS for styling (tailwind.config.ts).
• MongoDB via Mongoose (connectToDatabase utility).
• One-click copy functionality, Pinterest-like grid layout.
Main components
a. Browser (User Interface)
• React components served by Next.js (pages and client components under src/app)
• Static assets (fonts, style sheets)
b. Next.js Server (Server-Side Rendering + API Layer)
• Page rendering (SSR/SSG in app/page.tsx and nested routes)
• API Routes (serverless functions in src/app/api/*)
c. Authentication Service
• Clerk (handles sign-in, sign-up flows, session tokens)
d. Business Logic & Data Access
• Context Providers (GlobalContext, SnippetContext)
• Utility: generateCodeWithGemini.ts (optional code generation)
• connectToDatabase.ts (establishes MongoDB connection)
• Mongoose Models (User, Snippet)
e. Database
• MongoDB (collections: users, snippets)
Relationships and interactions
• Browser ↔ Next.js Pages: user navigates, SSR/CSR fetches UI and initial data.
• Browser ↔ Clerk: on auth pages, Clerk widget handles login/signup, returns JWT/session.
• Next.js API ↔ Clerk: middleware.ts verifies auth token on protected routes.
• Next.js API ↔ MongoDB: API route handlers import models, use connectToDatabase to read/write snippets or user data.
• Browser ↔ Next.js API: CRUD operations for snippets and user profile via fetch calls to /api/snippets and /api/save-user.
• Optionally, Next.js API ↔ Gemini Service: for dynamic code generation feature.
Architectural patterns and principles
• 3-Tier Architecture: Presentation (React/Next.js), Application/API (serverless functions), Data (MongoDB).
• Server-side rendering combined with client components.
• Context-based state management for UI.
• Externalized authentication (Clerk) to offload user security.
• Utility-driven modularity (connectToDatabase, generateCodeWithGemini).