Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xjqx/study-gpt
Your Powerful All-In-One Learning Companion Powered by ChatGPT
https://github.com/xjqx/study-gpt
chakra-ui firebase nextjs openai-api tailwindcss typescript
Last synced: 2 months ago
JSON representation
Your Powerful All-In-One Learning Companion Powered by ChatGPT
- Host: GitHub
- URL: https://github.com/xjqx/study-gpt
- Owner: xJQx
- Created: 2023-05-28T09:53:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-11T08:15:30.000Z (8 months ago)
- Last Synced: 2024-05-11T09:24:46.271Z (8 months ago)
- Topics: chakra-ui, firebase, nextjs, openai-api, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://study-gpt.vercel.app/
- Size: 9.96 MB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
StudyGPT
Your Powerful All-In-One Learning Companion Powered by ChatGPT
LifeHack 2023
View Demo
·
Report Bug
·
Request Feature
## 👋🏻 Introducing `StudyGPT`
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](https://study-gpt.vercel.app/)
>
> [YouTube Demo Link](https://youtu.be/hL6o276WFLU)
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:
```bash
git clone https://github.com/xJQx/study-gpt.git
```
2. Install dependencies
In the `study-gpt/` directory, run
```bash
npm install
```
3. Set up Environment Variables
Create a `.env` file in the root directory with all the environment variables listed in the `.env.example`.
```env
# .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=
```
4. Start up the application
```bash
npm run dev
```
5. 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
## ✨ Contributors
## 💡 Contributing
Have an idea or improvement to make? Create an issue and make a pull request!