shricodev / pdfwhisper-openai Goto Github PK

View Code? Open in Web Editor NEW

PDFwhisper allows you to have a conversation with your PDF docs. Finding info on PDF files is now easier than ever. 🚀🔥 Most secure authentication measures using Passkeys🔑

License: GNU General Public License v3.0

TypeScript 97.27% JavaScript 0.32% CSS 2.40%

pdfwhisper-openai's Introduction

Welcome to PDFwhisper🚀 👋

PDFwhisper allows you to have a conversation with your PDF docs. Finding info on your PDF files is now easier than ever.

🏠 Visit Website

✨ Demo

Install - (Suggested)

As this project uses free plan of OpenAI, it has limited access to the API. So, I suggest you to install it locally.

🔴 Make sure to populate all the .env variables before running the project as shown in .env.example. You can skip the env variables starting with KHALTI_

pnpm install

Dev Usage

pnpm run dev

Firm Promise - In Security 🔒

We use Hanko Passkey for authentication. The most modern and secure way to authenticate. You can be sure that your data is safe with us. ✅ Your data shall never be compromised.

The project currently supports Google, Github as our OAuth providers.

Tech Stacks

Frontend Technologies:
- ReactJS: A JavaScript library for building user interfaces.
- NextJS: A framework for building React applications with server-side rendering and routing.
- TailwindCSS: A utility-first CSS framework for designing responsive web applications.
- shadcn/ui: A custom UI component library.
Backend Technologies:
- NextJS - API Router: A built-in API router for Next.js applications.
Deployment and Hosting:
- Vercel: A cloud platform for hosting and deploying web applications, particularly well-suited for Next.js applications.
Authentication and Security:
- Hanko Passkey: The most secure modern authentication system using passkeys.
LLM and Vector Storage:
- VectorDB - Pinecone: Used for storing OpenAI vectors
- OpenAI: LLM for generating text.