Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quocdat-le-insacvl/pdf-flashcards-autogen
AI-powered interactive pdf reader with flashcards
https://github.com/quocdat-le-insacvl/pdf-flashcards-autogen
ai anki anki-flashcards autogenerate claude-3-5-sonnet flashcards generative-ai nlp pdf
Last synced: 8 days ago
JSON representation
AI-powered interactive pdf reader with flashcards
- Host: GitHub
- URL: https://github.com/quocdat-le-insacvl/pdf-flashcards-autogen
- Owner: quocdat-le-insacvl
- License: mit
- Created: 2024-08-15T09:58:27.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T00:42:46.000Z (about 1 month ago)
- Last Synced: 2024-09-21T14:04:52.670Z (12 days ago)
- Topics: ai, anki, anki-flashcards, autogenerate, claude-3-5-sonnet, flashcards, generative-ai, nlp, pdf
- Language: HTML
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PDF Flashcard Generator: AI Study Companion
Unlock the power of your PDFs with AI-driven learning! This web application transforms your documents into interactive flashcards and explanations using Claude AI, perfect for importing into **ANKI**. Ideal for students, researchers, and lifelong learners looking to supercharge their study sessions and spaced repetition practice.
> **Featured Project:** 🤗 [PDF with Flashcard Generation - a Hugging Face Space by quocdat25](https://huggingface.co/spaces/quocdat25/pdf-flashcards-autogen)
## Key Features:
- 📚 Upload and view PDFs directly in your browser
- 🤖 Generate flashcards and explanations with Claude AI
- 🖍️ Highlight important text for focused learning
- 💾 Save and export your flashcard collections to **ANKI**-compatible format
- 📱 Responsive design for desktop and mobile use
- 🔄 Seamless integration with **ANKI** for optimized spaced repetition
Dive into your documents, emerge with knowledge at your fingertips, and supercharge your **ANKI** decks!
## Getting Started
### Prerequisites
- Python 3.7+
- Flask
- Anthropic API key
### Installation
1. Clone the repository:
```
git clone https://github.com/quocdat-le-insacvl/pdf-flashcards-autogen.git
cd pdf-flashcards-autogen
```
2. Install the required packages:
```
pip install -r requirements.txt
```
3. Set up your Anthropic API key:
- Sign up for an API key at [https://www.anthropic.com](https://www.anthropic.com)
- Add your API key to the application when prompted
### Running the Application
1. Start the Flask server:
```
python app.py
```
2. Open your web browser and navigate to `http://localhost:5000`
## Usage
1. Upload a PDF file using the file input at the top of the page
2. Navigate through the PDF using the page controls or by scrolling
3. Select text in the PDF viewer
4. Click "Generate Flashcard" to create flashcards from the selected text
5. View, remove, or export generated flashcards
6. Use the highlight mode to mark important text in the PDF
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For discussing improvements or new features, we encourage you to open an Issue first to facilitate community discussion.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [PDF.js](https://mozilla.github.io/pdf.js/) for PDF rendering
- [Anthropic](https://www.anthropic.com) for the Claude AI API