How slider3132/pdf-converter works
Project type and purpose
• This is a single-page/full-stack web application built with Next.js (App Router) that runs primarily in the browser but relies on an external PDF-generation API.
• Purpose: Let users enter text, send it to a remote service to get back a PDF blob, display that PDF, and keep a history of generated PDFs in localStorage.
File structure
• Top-level config and scripts:
• jest.config.ts, jest.setup.ts (tests)
• next.config.ts (Next.js settings)
• postcss.config.mjs, tailwind.config.js (CSS)
• tsconfig.json (TypeScript)
• Public assets: public/
• Source code under src/:
• src/app/ – Next.js App Router pages/layout/globals.css
• src/api/index.ts – wrapper around Axios calls to external API
• src/modules/convertor/ – core “convertTextToPDF” logic
• src/components/ – UI: TextInput, PdfViewer, HistoryWidget
• src/hooks/ – custom React hooks (localStorage, isClient)
• src/utils/ – helper functions (e.g., base64 ↔ Blob conversion)
• src/tests/ – unit tests for conversion module
README for additional insights
• Tech stack: Next.js 15, TypeScript, Tailwind CSS, Axios, @react-pdf-viewer/core, Jest
• Environment variables: DOMAIN and API_KEY used by convertTextToPDF
• Core flow:
• TextInput collects user text
• ConverterModule sends POST to ${DOMAIN}/create-pdf?apiKey=…, gets Blob
• PdfViewer displays PDF via @react-pdf-viewer/core
• HistoryWidget reads/writes base64-encoded PDFs to localStorage
Diagramming recommendations
• From TextInput → ConverterModule → External API → ConverterModule
• From ConverterModule → PdfViewer (render path)
• From ConverterModule → localStorage (save) → HistoryWidget → PdfViewer (retrieve)
• UI components (e.g., light blue rectangles)
• Business logic modules (e.g., green rounds)
• External service (e.g., orange)
• Rectangles for components/modules
Detail
• Hook usage by annotating localStorage interactions with the hook names (useLocalStorageBase64).
• Don’t overcomplicate: focus on the five key elements—UI, converter logic, storage, external API, PDF viewer—and their interactions.