Study Genie
Summarize long readings into structured study guides and key points.
Modern, responsive UI with instant global performance on Vercel.
Optional authentication, payments, and database for SaaS-style plans and limits.
🚀 Live demo https://study-genie-nine.vercel.app/
🧰 Tech stack Frontend: Next.js + React with modern routing and optimizations.
Backend: Next.js API routes, serverless/edge-friendly handlers.
AI: Swappable providers via AI SDK patterns (OpenAI/Anthropic/Cohere supported).
Database: PostgreSQL (serverless-friendly) or bring-your-own.
Auth/Payments (optional): Auth.js/Clerk and Stripe.
Hosting: Vercel.
🖼️ Visual style headers Use picture-based “colored headings” for sections by inserting banner badges that adapt to theme:
🧪 Code-highlight accents Leverage language-tagged code blocks and diff blocks to inject color where helpful:
text
- Ready to learn faster!
- Wasting time on manual note-making ! Bring your own API key
🧭 Getting started
API keys as needed (OpenAI/Gemini/etc.).
Install:
git clone https://github.com//study-genie.git
cd study-genie && npm install
Environment variables:
Create .env.local and set:
NEXT_PUBLIC_APP_URL=https://study-genie-nine.vercel.app
OPENAI_API_KEY=sk-... or GEMINI_API_KEY=...
CLERK_API_KEY=... and NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=... (if using auth)
STRIPE_SECRET_KEY=... and NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=... (if using payments)
DATABASE_URL=postgres://... (Postgres/Neon)
Run locally:
npm run dev → http://localhost:3000
Build and start:
npm run build
npm start
🗂️ Project structure app/ or pages/: Routes and SSR handlers.
pages/api/: Generation, uploads, and webhooks.
components/: Uploader, cards, quiz, layout.
lib/: AI adapters, DB clients, utilities.
public/: Static assets and screenshots.
🧩 Configuration AI provider: Switch via AI SDK patterns; set provider keys in env.
Limits: Control token/length limits per route or plan tier.
Env hygiene: Keep secrets server-side; only expose NEXT_PUBLIC_ values to the client.
📦 Deployment Import the repo on Vercel; configure environment variables in Project Settings.
Build command: npm run build; Next.js defaults are supported.
Optionally pull envs locally with vercel env pull.
🔐 Security Do not commit .env files or secrets to version control.
Keep sensitive keys unprefixed (not NEXT_PUBLIC_) to avoid client exposure.
Follow Next.js env precedence to avoid accidental overrides.
🗺️ Roadmap Export flashcards to CSV/Anki for spaced repetition.
Streaks and scheduling features for practice.
Multi-provider AI switches and cost controls via AI SDK.
🤝 Contributing Fork → feature branch → PR with scope and screenshots.
Prefer TypeScript, lint consistently, and keep PRs focused.
📄 License This project is licensed under the MIT License; see LICENSE.
Notes on color in README:
GitHub strips inline CSS; use badges, images, code highlighting, and picture for dark/light adaptation.
Shields.io supports custom colors, logos, and styles for visually distinct section headers.