https://github.com/shricodev/pdfwhisper-openai
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🔑
https://github.com/shricodev/pdfwhisper-openai
api-router chatbot hacktoberfest hanko nextjs openai passkeys pdf-chatbot pdf-viewer prisma react shadcn-ui
Last synced: 13 days ago
JSON representation
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🔑
- Host: GitHub
- URL: https://github.com/shricodev/pdfwhisper-openai
- Owner: shricodev
- License: gpl-3.0
- Created: 2023-10-18T17:45:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-30T17:26:08.000Z (6 months ago)
- Last Synced: 2024-10-30T18:30:26.079Z (6 months ago)
- Topics: api-router, chatbot, hacktoberfest, hanko, nextjs, openai, passkeys, pdf-chatbot, pdf-viewer, prisma, react, shadcn-ui
- Language: TypeScript
- Homepage: https://pdfwhisper-openai.vercel.app
- Size: 2.25 MB
- Stars: 10
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://pdfwhisper-openai.vercel.app)
### ✨ [Demo](https://pdfwhisper-openai.vercel.app)
## 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_`
```sh
pnpm install
```
## Dev Usage
```sh
pnpm run dev
```
## Firm Promise - In Security 🔒
> We use [Hanko Passkey](https://hanko.io) 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.
## Author
👤 **Shrijal Acharya @shricodev**
- Website: https://shricodev.tech
- Twitter: [@shricodevv](https://twitter.com/shricodevv)
- Github: [@shricodev](https://github.com/shricodev)
- LinkedIn: [@shrijal007](https://linkedin.com/in/shrijal007)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/shricodev/pdfwhisper-openai/issues).
## Show your support
Give a ⭐️ if this project helped you!