Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmadrosid/pdfpintar
Chat with PDF documents.
https://github.com/ahmadrosid/pdfpintar
Last synced: 6 days ago
JSON representation
Chat with PDF documents.
- Host: GitHub
- URL: https://github.com/ahmadrosid/pdfpintar
- Owner: ahmadrosid
- License: agpl-3.0
- Created: 2023-05-15T09:58:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-27T09:20:55.000Z (10 days ago)
- Last Synced: 2024-10-28T09:26:37.041Z (9 days ago)
- Language: PHP
- Homepage: https://pdfpintar.com
- Size: 8.67 MB
- Stars: 93
- Watchers: 4
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## PDFPintar
PDFPintar is a web application designed for chatting with your PDF documents. It's built using Laravel, Livewire, and a bit of React.
## Requirements
- PHP 8.1+
- Composer
- Node.js and npm
- MySQL or SQLite
- OpenAI API key
## Installation
1. Clone the repository:
```
git clone https://github.com/ahmadrosid/pdfpintar.git
cd pdfpintar
```
2. Install PHP dependencies:
```
composer install
```
3. Install JavaScript dependencies:
```
npm install
```
4. Copy the `.env.example` file to `.env` and configure your environment variables:
```
cp .env.example .env
```
Make sure to set `OPENAI_API_KEY` and `OPENAI_ORGANIZATION` in your `.env` file.
5. Generate an application key:
```
php artisan key:generate
```
6. Run database migrations:
```
php artisan migrate
```
7. Build frontend assets:
```
npm run build
```
8. Link storage:
```
php artisan storage:link
```
9. Start the development server:
```
php artisan serve
```
## Environment Variables
Make sure to set the following environment variables in your `.env` file:
```
OPENAI_API_KEY=your_openai_api_key_here
OPENAI_ORGANIZATION=your_openai_organization_id_here
```
Replace `your_openai_api_key_here` with your actual OpenAI API key, and `your_openai_organization_id_here` with your OpenAI organization ID if applicable.
## Contribution
If you want to contribute to this project, I really appreciate it. Here are some things you can do:
1. Report [issues](https://github.com/ahmadrosid/pdfpintar/issues) if you encounter errors or bugs.
1. Submit [pull requests](https://github.com/ahmadrosid/pdfpintar/pulls) for bug fixes, adding new features, or improving documentation.
## LICENSE
AGPL-3.0 license