Git Product home page Git Product logo

nextjs-pdf-inquiry-project's Introduction

PDF AI Inquiry Project (SAAS)

Welcome to the PDF AI Inquiry project! This Next.js (TypeScript) application empowers users to upload PDFs and seamlessly interact with AI to ask questions related to their documents. Here's a quick overview of the technologies used:

Technologies Used:

  • Next.js App Router: Leveraging the power of Next.js for a seamless and efficient user experience.

  • Tailwind CSS with Shadcn: Stylishly designed using Tailwind CSS & Shadcn, ensuring an attractive and responsive UI.

  • Clerk: Auth implementation with login/register pages using @clerk/nextjs.

  • NeonDB: Utilizing NeonDB for efficient and reliable database management.

  • PineconeDB: Storing AI-related data, including namespaces and metrics, to enhance the overall AI functionality.

  • OpenAI API: Integrating OpenAI API to provide users with a sophisticated and interactive chat experience.

Getting Started:

  1. Clone the repository: git clone https://github.com/ikramdeveloper/nextjs-pdf-inquiry-project.git
  2. Install dependencies: npm install
  3. Configure NeonDB and PineconeDB credentials.
  4. Set up your OpenAI API key.
  5. Configure any of Cloudinary, Google Cloud Storage or S3 bucket. Use uploadToStorage function according to configuration in lib/storage.ts
  6. Run the project: npm run dev

Usage:

  1. Upload PDFs: Users can easily upload their PDF documents through the intuitive interface.

  2. Ask AI Questions: Engage with the AI functionality to ask questions related to the uploaded PDFs.

Project Structure:

  • app/: Contains the Next.js app for different sections of the application.
  • app/api/: Next.js apis for different routes.
  • services/: Write code for querying or mutating apis data with axios.
  • lib/db/: Configurations and schemas for NeonDB.
  • lib/pinecone: Configurations and queries for PineconeDB.
  • components/: Reusable React components for a modular and maintainable codebase.
  • types/: Typescript types for variables
  • config/: Configuration values and constants to use throughout the application

Configuration:

Make sure to update the configuration files with your specific credentials for NeonDB, PineconeDB, and the OpenAI API.

Contributing:

Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.

Todo:

  • Payment integration with Stripe

License:

This project is licensed under the MIT License.

Thank you for using the PDF AI Inquiry Project! If you have any questions or feedback, don't hesitate to reach out. Happy coding!

Author Links:

๐Ÿ‘‹ Hello, I'm Ikram Ul Haq - Web Developer & Programmer

โ˜• Buy Me A Coffee

๐Ÿš€ Follow Me:

nextjs-pdf-inquiry-project's People

Contributors

ikramdeveloper avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.