Skip to content

amnazahid99/AI-FlashCards

Repository files navigation

Overview

Flashcard AI SaaS is a web-based platform designed to assist users in creating, managing, and reviewing flashcards with the help of advanced AI functionalities. This tool utilizes AI to generate, customize, and analyze flashcards, making the study process more efficient and productive.

Features

  • AI-Generated Flashcards: Automatically create flashcards from user input and AI recommendations.
  • Personalized Flashcards: Design and edit flashcards with custom content tailored to your needs.
  • Diverse Review Options: Various review methods, including spaced repetition, to improve retention.
  • Progress Tracking: Monitor your study progress and performance through comprehensive analytics.
  • Secure Access: User authentication and account management.

Technologies

  • Frontend: React, Next.js
  • Backend: Node.js
  • AI Integration: OpenAI API
  • Database: Firebase Datastore
  • Deployment: Vercel
  • CI/CD: Vercel
  • Authentication: Clerk
  • Payment: Stripe

Installation

Prerequisites

  • Node.js (>= 14.x)
  • npm or yarn

Setup

  1. Clone the Repository

    git clone https://github.com/amnazahid99/AI-FlashCards.git
    cd AI-FlashCards
  2. Install Dependencies

    npm install

    or

    yarn install
  3. Configure Environment Variables

    Create a .env file in the root directory and add the following environment variables:

    NEXT_PUBLIC_STRIPE_PUBLIC_KEY=your_public_key
    OPENAI_API_KEY=your_openai_api_key
    STRIPE_SECRET_KEY=your_secret
  4. Run the Application

    npm run dev

    or

    yarn dev

    The application will be accessible at http://localhost:3000.

Deployment

To deploy the application, follow these steps:

  1. Build the Application

    npm run build

    or

    yarn build
  2. Deploy to Vercel

    For Vercel, you can directly connect your GitHub repository and configure deployment settings in the Vercel dashboard.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors