How shreykoradia/peerlist-shrey works
Project type and purpose
• This is a full-stack, monorepo Next.js application that enables users to build, preview, publish, and fill out dynamic forms.
• It combines hybrid SSR/CSR front-end (form builder in CSR, published forms in SSR) with API routes in the same codebase and a MongoDB backend.
File structure
• Top-level files: next.config.js, Tailwind, ESLint, tsconfig, etc.
• src/app & src/pages: Next.js routing layer (app-directory for CSR/SSR pages, pages/api for serverless endpoints).
• src/modules: feature modules (form-builder, form-viewer, question-builder).
• src/shared: UI components, store (Zustand), and lib (MongoDB connection, constants).
• src/model & src/types: domain models and TypeScript types.
README for insights
• Uses Next.js for UI and API routes, Zustand for client state, MongoDB/Mongoose for persistence.
• Mix of SSR (published forms) and CSR (form creation).
• Core features: form creation CRUD, preview, publish, submission, and completion tracking.
Main components
A. Client (Browser) – Next.js front-end
• Form Builder UI (CSR)
– Modules: question-builder, form-builder components
– Zustand store (src/shared/store/form.ts)
– Tailwind UI library (src/shared/ui)
• Form Preview & Layout in “preview” mode (readonly CSR)
• Published Form Page (SSR on server, data fetched at request time)
B. Server (Next.js runtime)
• Next.js API Routes (src/pages/api/forms/*)
– Endpoints:
· GET/POST /api/forms → list/create forms
· GET/POST /api/forms/[id] → read or submit form responses
· POST /api/forms/publish → publish a form
– Business logic lives here or in src/modules/*/api.ts
• Data Access Layer
– MongoDB connection (src/shared/lib/mongoDb.ts)
– Mongoose schemas in src/model/form.model.ts
C. Database
• MongoDB cluster (external service)
• Collections: forms, responses
Relationships and data flows
1. User interacts with Form Builder UI → updates Zustand store.
2. On save/publish: front-end issues HTTP POST/PUT to Next.js API route.
3. API route calls Mongoose methods → persists form to MongoDB.
4. Publishing triggers SSR page generation for /form/[formId] route.
5. End users access published form → SSR GET /form/[formId] → fetch form data from DB → render HTML.
6. User submits answers → POST /api/forms/[id]/submit → write responses to DB → return status.
7. Front-end reads completion percentage either via CSR queries or SSR props.
Architectural patterns & design principles
• Layered architecture: Presentation (Next.js pages/components) → Application (API routes + feature modules) → Data (Mongoose + MongoDB).
• Module pattern: each feature (form-builder, form-viewer, question-builder) encapsulated under src/modules.
• Shared libraries (src/shared) enforce DRY for UI, state, and database glue.
• Hybrid rendering: CSR for builder and preview; SSR for published form pages.
Final checklist
• All major modules and layers represented.
• Data flows shown for create, preview, publish, and submit operations.
• Tech stack callouts (Next.js, Zustand, Mongoose, MongoDB, Tailwind).
• Hybrid rendering path (SSR vs CSR) is explicit.