The Flashcard Generator is an AI-powered application that allows users to generate flashcards from uploaded PDF files. The app processes structured text, extracts keywords and entities, and generates relevant question-answer pairs to aid learning. This project is designed to run locally without cloud dependency and is integrated with Qualcomm technologies for optimized on-device inference.
- [Junjie Li] - [email protected]
- [Hui Zhou] - [email protected]
- [Meredith Luo] - [email protected]
- [Rouming Zhang] - [email protected]
- [Tiantian Huang] - [email protected]
- Backend: https://github.com/takkujunjieli/flashcard-backend main branch
- Frontend: https://github.com/mereluo/flashcard-generator main branch
Contact us if you have any questions about the setup
Prerequisites
Ensure you have the following dependencies installed:
Python 3.8+
Node.js (>= 14.0.0)
npm (>= 6.0.0)
Clone the repository:
git clone https://github.com/your-repo/flashcard-backend.git
cd flashcard-backend
Create a virtual environment:
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
Install dependencies:
pip install -r requirements.txt
Download necessary NLP models:
python -m nltk.downloader punkt
python -m spacy download en_core_web_sm
Start the FastAPI server:
uvicorn main:app --reload
The API will be available at http://127.0.0.1:8000
Clone the repository:
git clone https://github.com/your-username/flashcard-generator.git
cd flashcard-generator
Install dependencies:
npm install
Running the Application
npm run dev
- Upload a PDF to generate flashcards automatically.
- Choose the selected type of card number, role and purpose, or customize your flashcard generation prompt.
- Edit flashcards using the interactive editor.
- Navigate through flashcards using the carousel or list view.