Skip to content
/ study-gpt Public

Your Powerful All-In-One Learning Companion Powered by ChatGPT

Notifications You must be signed in to change notification settings

xJQx/study-gpt

Repository files navigation

StudyGPT

StudyGPT

Your Powerful All-In-One Learning Companion Powered by ChatGPT

LifeHack 2023

licence forks stars issues pull-requests

View Demo · Report Bug · Request Feature

👋🏻 Introducing StudyGPT

StudyGPT landing page

Looking to take your learning to the next level? Introducing our Powerful All-In-One Learning Companion, StudyGPT! Packed with powerful features, it's designed to simplify your learning journey and maximize your potential.

Get ready to supercharge your learning journey with our powerful companion. Seamlessly log in, access concise summaries, clarify doubts at your convenience, and reinforce knowledge with personalized flashcards. Experience the future of learning - try it today!


🚀 Demo

Here is a quick demo of the app. We hope you enjoy it.

Website Demo Link

YouTube Demo Link

Liked it? Please give a ⭐️ to StudyGPT.


🔥 Features

StudyGPT comes with 4 key features:

Feature 1: Google Authentication

Login seamlessly with your Google account for quick and secure access. Experience the perfect balance of convenience and top-notch security.

Feature 2: Summariser

Unlock the essence of complex concepts effortlessly. Our summarization feature condenses lengthy and abstract notes into sleek summaries, giving you a sneak peek into the bigger picture.

Feature 3: Explainer

No more doubts holding you back! Our interactive platform provides instant, intelligent responses to your queries, empowering you to clarify new concepts whenever you need.

Feature 4: Flashcard Generator

Retain knowledge for the long term and elevate your learning. Craft personalized flashcards based on your own notes, reinforcing your understanding of the concepts you've learned.


💪🏻 Try Yourself

  1. Get a copy of this repository by opening up your terminal and run:
git clone https://github.com/xJQx/study-gpt.git
  1. Install dependencies

In the study-gpt/ directory, run

npm install
  1. Set up Environment Variables

Create a .env file in the root directory with all the environment variables listed in the .env.example.

# .env file with all your environment variables

OPEN_AI_API_KEY=

# Firebase
NEXT_PUBLIC_API_KEY= 
NEXT_PUBLIC_AUTH_DOMAIN= 
NEXT_PUBLIC_PROJECT_ID= 
NEXT_PUBLIC_STORAGE_BUCKET= 
NEXT_PUBLIC_MESSAGING_SENDER_ID= 
NEXT_PUBLIC_APP_ID= 
NEXT_PUBLIC_DATABASE_URL= 

# Firebase google authentication
WEB_CLIENT_ID=
WEB_CLIENT_SECRET=
  1. Start up the application
npm run dev
  1. Open http://localhost:3000/ in your browser, login, and enter your OpenAI API Key

Congratulations, you have successfully created your own copy of StudyGPT.


🏗️ Tech Stack

Next JS TypeScript TailwindCSS Chakra Firebase


✨ Contributors


💡 Contributing

Have an idea or improvement to make? Create an issue and make a pull request!