How ravneet0628/pdfolio works
Project type and purpose
• PDFolio is a single-page, client-side PDF utility web app.
• It’s built with React and Vite, styled with Tailwind CSS, and performs all PDF manipulations in the browser (no backend).
File structure
• Top level: configuration files (package.json, vite.config.js, Tailwind via index.css), index.html.
• src/
• main.jsx & index.css: entrypoint & global styles
• App.jsx: root component with router & ThemeContext
• components/: reusable UI bits (Navbar, Footer, Button, Spinner, ScrollToTop, ThemeContext provider)
• pages/: each PDF tool is a page (Merge, Split, Rotate, etc.)
• utils/: core PDF logic (mergePDF, splitPDF, deletePages, outputFilename)
• pdfWorker.js: Web Worker for off-thread PDF processing
• No backend directories—purely a front-end SPA.
Extract additional insights from README
• Uses pdf-lib & pdfjs-dist for PDF parsing/manipulation in-browser.
• Drag-and-drop powered by @dnd-kit.
• Vite for dev & build, React Router implied by multi-page structure.
a. Main components:
• Browser/Client
• index.html & Vite bundle
• React App (App.jsx)
• ThemeContext (for dark/light mode)
• Router → Pages (Merge, Split, Compress, etc.)
• Shared Components (Navbar, Footer, Button, Spinner, Grid, Uploader)
• pdfWorker.js (Web Worker)
• Utils (mergePDF, splitPDF, deletePages, etc.)
• Third-party libs (pdf-lib, pdfjs-dist, @dnd-kit, Tailwind)
• Download API (FileSaver/browser download)
b. Relationships & data flow:
1. index.html loads the Vite-bundled JS/CSS.
2. main.jsx mounts App to DOM, wraps it in ThemeContext.
3. App.jsx sets up Router → renders a Page component based on URL.
4. User interacts with a Page (e.g., uploads PDF via FileUploader component).
5. Page posts file data to pdfWorker.js for heavy lifting.
6. pdfWorker uses pdf-lib/pdfjs-dist via utils/*.js to perform operations.
7. Worker returns processed PDF blob back to main thread.
8. Page triggers browser download (saveAs or similar).
9. Shared UI components (LoadingSpinner, SortableThumbnailsGrid) reflect state & drag-and-drop via @dnd-kit.
c. Architectural patterns & principles:
• Component-based UI (React)
• Separation of concerns: UI vs. PDF logic (utils + worker)
• Offload CPU-intensive tasks to Web Worker
• Context API (ThemeContext) for cross-cutting state
• Client-only, no server dependencies → static deployment
d. Key technologies:
• React + React Router
• Vite (dev server/bundler)
• Tailwind CSS
• pdf-lib & pdfjs-dist (PDF manipulation)
• @dnd-kit (drag-and-drop)
• Web Worker (pdfWorker.js)