Skip to content

Latest commit

 

History

13 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pinpoint

Pinpoint explains confusing terms in dense PDFs — contracts, forms, papers, policies — without leaving the page.

Upload a document and Pinpoint finds likely-unfamiliar words and phrases, then underlines them on the PDF. Click an underline and a side panel explains that term in plain English, using the surrounding text so the meaning stays grounded in this document. The same word on two pages gets two explanations: each one is tied to its local context.

The panel is a session log of terms you have opened, not a chatbot and not a glossary of every detected word. Explanations are written for a general reader and are not legal, medical, or financial advice.

Developer details live in docs/technical-overview.md.

Run locally

Run the backend and frontend in two terminals. The Vite app on port 5173 proxies /api to FastAPI on port 8000.

Backend

cd backend
python -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -r requirements.txt
cp .env.example .env

Set GEMINI_API_KEY in backend/.env. Then:

uvicorn main:app --reload --port 8000

Health check: http://localhost:8000/health.

Scanned PDFs also need Tesseract installed on the machine. Digital (text-selectable) PDFs do not.

Frontend

cd frontend
npm install
npm run dev

Open http://localhost:5173.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages