Skip to content

Alif-4/Flashcards-SaaS

Repository files navigation

Flashcard SaaS

Flashcard generation platform that helps you turn any text into study flashcards automatically via AI.

What Does It Do?

  • Generate Flashcards: Write text and AI creates flashcards for you
  • Save & Organize: Store your flashcards in collections
  • Study Anywhere: Access your flashcards from any device
  • Subscription Model: Upgrade for unlimited flashcards and storage

Prerequisites

Project requires accounts with:

  1. Clerk (clerk.com) - For user login/signup
  2. OpenAI (openai.com) - For AI flashcard generation
  3. Stripe (stripe.com) - For payments
  4. Firebase (firebase.google.com) - For storing flashcards

Setup Instructions

1. Install Dependencies

npm install

2. Set Up Environment Variables

.env.local file with:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key
OPENAI_API_KEY=your_openai_api_key
STRIPE_SECRET_KEY=your_stripe_secret_key
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key

3. Configure Firebase

Firebase configuration in firebase.js

4. Run the App

npm run dev

Open local host to see test app

Deployment

Deploy to Vercel:

  1. Push code to GitHub
  2. Import your repo on Vercel
  3. Add all environment variables in Vercel settings
  4. Deploy

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors