Skip to content

hoangph271/pdf-indexer

Repository files navigation

pdf-indexer

This is a Next.js project bootstrapped with create-next-app.

Project Description

pdf-indexer is a web application that generates an index page for a dynamic multi-page PDF document.
The index page lists the title of each section along with its page number.

Environment setup

To start developing pdf-indexer, you'll need:

  • Node.js (only v22.2.0 was tested)
  • pnpm (only v9.1.4 was tested)

The project was initialized and developed on a Linux machine (Pop!_OS jammy 22.04 x86_64).
However, since pdf-indexer doesn't have any platform-specific dependencies, it is expected to be portable and can be deployed to other environment with minimal changes.

Getting Started

First, run the development server:

pnpm run dev

Open http://localhost:3000 with your browser to see the result.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

Next.js

To learn more about Next.js, take a look at the following resources:

PDF Manipulation:

The project use the following modules to parse & manipulate PDF files:

Deploy with Docker:

The project contains a docker-compose.yml and a Dockerfile.

To deploy pdf-indexer using Docker, you'll only need Docker Engine or Docker Desktop installed.

Then run:

docker compose up -d --build

Deploy on Vercel

⚠️ Deploying on Vercel is currently broken due to a puppeteer issue. ⚠️

The easiest way to deploy is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.