An intelligent study tool that transforms your notes into interactive, fill-in-the-blank quizzes using the power of the OpenAI API.
QuickStudyGPT is a full-stack web application designed to enhance the learning process. Users can submit their study notes, and leveraging sophisticated prompt engineering, the application communicates with the OpenAI API to generate a custom-tailored quiz. The goal is to provide an active-recall study method that is both effective and engaging.
- AI-Powered Quiz Generation: Pastes or types study notes to be analyzed by the OpenAI (ChatGPT) API.
- Customizable Quizzes: Users can specify the number of fill-in-the-blank questions they want.
- Interactive Learning: Actively answer questions to reinforce knowledge.
Next.js, React, Tailwind CSS
Deno.js
Google Firestore, MongoDB
OpenAI API (GPT-4 / GPT-3.5)
Docker, Docker Compose
To run this project locally, you will need Git, Node.js, Deno, and Docker installed.
Clone the repository:
git clone https://github.com/your-username/QuickStudyGPT.git
cd QuickStudyGPT
Set up Environment Variables: This project requires API keys and configuration for the backend.
Create a file named .env in the server/ directory:
OPENAI_API_KEY="your-openai-api-key"
REFRESH_TOKEN_SECRET="your-jwauth-refresh-secrent"
ACCESS_TOKEN_SECRET="your-jwauth-access-secret"
Build and Run with Docker Compose:
docker-compose up -d --build
The docker-compose.yml file will build the images for both services and run them.
Access the application: Open your browser and navigate to http://localhost:3000