Skip to content

Java/React application for the web that helps students practice for AP Exams by integrating ChatGPT's API to generate questions and provide feedback for those questions. Built on React, Maven, Spring Boot, node.js. Utilizes API's from simple-openai and Firebase. Website hosted through Render and Docktype; Terraform used for IaC.

License

Notifications You must be signed in to change notification settings

liamkernan/HELPSTUDYME

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

180 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About the Project

helpstudy.me is an AI-powered study companion built to generate unlimited practice questions, deliver instant feedback, and track your progress—completely free.

Under the hood, it’s a React front-end with KaTeX for rigid math rendering, talking to a back-end that proxies to OpenAI’s API to not only craft questions across AP, SAT, ACT, and any other “quiz” you want to master, but also provide feedback on Free Response writing, and offer studying priorites based on multiple choice responses and accuracy. Firebase is used for user authentication and to perserve student progress, regardless of where or what device your accessing from.

Created by Liam Kernan to help fellow students study not just harder, but smarter.

Installation

Prerequisites: Node.js ≥14, Java 17+, Maven, Firebase CLI

  1. Clone the repo:
    git clone https://github.com/liamkernan/HELPSTUDYME.git
  2. Install client dependencies:
    cd HELPSTUDYME/client && npm install
  3. Build server:
    cd ../server && mvn clean install
  4. Create environment variables:
    OPENAI_API_KEY, REACT_APP_FIREBASE_API_KEY, REACT_APP_API_BASE in .env files
  5. Start frontend:
    cd frontend/ap-question-generator, npm start (in /client)
  6. Start backend:
    cd backend, mvn spring-boot:run (in /server)

Usage

Navigate to http://localhost:3000, sign in with Firebase, select a question type, and generate your practice questions instantly.

Features

  • Generate multiple‑choice & free‑response questions on-demand, along with comprehensive study guides on any topic
  • Render complex math expressions & code scripts with KaTeX
  • Responsive, modern UI styled with Tailwind CSS
  • Authentication, user data, and real‑time updates via Firebase
  • simple-openAI API proxy for prompt management

Built With

JavaScript, Java, Node.js, React, Spring Boot, simple-openai-api, Firebase, KaTeX, Tailwind CSS

Contributing

Contributions are welcome; just open a pull request!

License

This project is licensed under the MIT License; more information can be found in LICENSE.txt at the project root.

About

Java/React application for the web that helps students practice for AP Exams by integrating ChatGPT's API to generate questions and provide feedback for those questions. Built on React, Maven, Spring Boot, node.js. Utilizes API's from simple-openai and Firebase. Website hosted through Render and Docktype; Terraform used for IaC.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors