Skip to content

Latest commit

 

History

History
221 lines (155 loc) · 8.39 KB

README.md

File metadata and controls

221 lines (155 loc) · 8.39 KB
Raw


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

Welcome to Alpaca, a cutting-edge web application designed to transform your PDF reading experience. Inspired by the powerful capabilities of chatGPT, Alpaca employs advanced artificial intelligence to analyze the content of your PDF documents and provide detailed answers to your questions.

Key Features:

Intelligent Document Analysis: Alpaca goes beyond traditional PDF readers by leveraging AI to understand the content within your documents. It comprehensively processes text, identifies key information, and extracts valuable insights.

Question-Driven Responses: Interact with your documents like never before. Ask questions related to the content, and Alpaca will generate accurate and contextually relevant answers. Whether you're seeking specific details or a broader understanding, Alpaca has you covered.

User-Friendly Interface: We believe in simplicity and accessibility. Alpaca features an intuitive interface that allows you to effortlessly upload your PDFs, ask questions, and navigate through the generated responses. Enjoy a seamless and efficient user experience.

Secure Document Handling: Your privacy and data security are our top priorities. Alpaca ensures the confidentiality of your documents during the analysis process. We do not store any sensitive information, providing you with peace of mind.

How It Works:

Upload Your PDF: Begin by uploading your PDF document through the user-friendly interface. Alpaca supports a wide range of PDF files, from research papers to reports and beyond.

Ask Questions: Once your document is uploaded, engage with it by asking questions. Alpaca's AI engine will process your queries, analyze the content, and generate accurate responses in real-time.

Explore Insights: Dive into the detailed answers provided by Alpaca. Uncover hidden gems within your documents, gain a deeper understanding of the content, and save time by extracting key information effortlessly.

Why Alpaca?

Efficiency: Alpaca streamlines your reading process, allowing you to quickly extract relevant information from lengthy documents. Precision: The AI-powered analysis ensures that the responses are contextually accurate, providing you with reliable insights. Innovation: Embrace the future of document interaction. Alpaca represents a leap forward in the integration of AI and document reading. Revolutionize your PDF reading experience with Alpaca. Say goodbye to traditional reading methods and embrace a new era of efficiency and intelligence. Get started today!

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next JS
  • React
  • TailwindCSS
  • ChatGPT
  • NodeJS
  • React Query
  • AWS
  • TypeScript
  • Postgresql

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/your_username/Project-Name.git
  2. Install NPM packages 
    npm install
  3. Enter your API in .env.local
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/

#NEONdb
DATABASE_URL=

#AWS-S3
NEXT_PUBLIC_S3_ACCESS_KEY_ID=
NEXT_PUBLIC_S3_SECRET_KEY=
NEXT_PUBLIC_S3_BUCKET_NAME=

#Pinecone ENV
PINECONE_ENVIRONMENT=
PINECONE_API_KEY=

#OPENAI
OPENAI_API_KEY=

#STRIPE
STRIPE_API_KEY=

NEXT_PUBLIC_BASE_URL=http://localhost:3000
STRIPE_WEBHOOK_SECRET=

(back to top)

Usage

Demo video of how Alpaca works:

recording-2023-12-09-210027_vRcc4bhU.mp4

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @xmayuk_hx - [email protected] Project Link: https://github.com/xmayukx/alpaca

(back to top)