Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.16 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.16 KB

Smart PDF AI

Smart PDF AI is a full-stack web application built to help users interact with and summarize PDFs using AI. This project is designed to make long and boring PDFs more engaging and easier to digest. Whether you're a student or professional, this app allows you to chat with PDFs, summarize PDFs, and store them securely in the cloud for easy access anywhere.

Features

  • Chat with PDFs: Ask questions about the contents of your PDF, and receive AI-powered responses.
  • Summarize PDFs: Generate concise summaries of long PDFs to save time and effort.
  • Cloud Storage: Store your PDFs securely in the cloud and access them anytime, anywhere.
  • Subscription & Payment Integration: Premium features available for advanced functionalities.
  • Seamless User Interface: Built with ShadCN UI for a clean and responsive design.

Tech Stack

  • Frontend: Next.js with TypeScript
  • UI Framework: ShadCN UI for an intuitive and modern UI
  • Backend & Database: Firebase for authentication and data storage
  • AI Integration: OpenAI (future-ready for Meta AI’s Llama 3)
  • Deployment: Deployed via Vercel for fast and scalable performance

Installation & Setup

  1. Clone the repository:

    git clone repositoryURL
  2. Install dependencies:

    cd smart-pdf-ai
    npm i
  3. Set up Firebase:

    • Create a Firebase project and add Firebase credentials (API keys).
    • Set up Firebase Authentication and Firestore.
    • Add your Firebase configuration to the .env.local file.
  4. Set up OpenAI API (or Meta AI Llama 3):

    • Sign up for an OpenAI account (or Meta AI account).
    • Generate your API key and add it to the .env.local file.
  5. Run the development server:

    npm run dev

Your application should now be live on http://localhost:3000.

Contact & Database Setup Assistance

If you need any help with setting up the database or the Firebase configuration, feel free to reach out to me. I'm happy to assist!

Contributing

Contributions are welcome! Feel free to fork the repository, submit pull requests, or open issues.