studybuddy.
A GUIDE FOR BEGINNERS

Baby Steps Setup ✦

Want to run the included Python + Streamlit version from your own GitHub repository? Follow these little steps, one at a time.

A quick note about Grok

The Streamlit edition can use Grok through xAI's API if your account has access. Free Grok chat is separate and does not automatically include free API usage. Never put an API key in your GitHub repo. This interactive web preview uses the app's built-in AI instead.

YOUR CHECKLIST

From idea to your own app

0 of 5 steps complete
STEP 01

Create your GitHub repository

Make a new repository, then add the included app.py, requirements.txt, and .streamlit/secrets.toml.example files. Keep your real secrets out of Git.

Open GitHub
STEP 02

Install the dependencies

Install Python, then run pip install -r requirements.txt in your project folder. The included Python app uses Streamlit and requests.

Streamlit installation guide
STEP 03

Connect Grok securely

If your xAI account has API access, create .streamlit/secrets.toml locally with your XAI_API_KEY. Never commit this file. Free Grok chat does not automatically include free API usage.

Check xAI API access
STEP 04

Test on your computer

Run streamlit run app.py, open the local address, and try each learning tool. If you do not have API access yet, the app shows clear setup guidance instead of pretending to answer.

Streamlit docs
STEP 05

Deploy to Streamlit Community Cloud

Push your code to GitHub, connect the repo in Streamlit Community Cloud, and paste your XAI_API_KEY into the app’s Secrets settings. Then test the deployed app.

Open Community Cloud

The repository also includes README.md, .gitignore, and .streamlit/secrets.toml.example for your GitHub setup.

StudyBuddy AI is here to help you learn, not replace your teacher or trusted sources. Always verify important AI-generated answers.
⚡Remix on GenMB