Swift-Cards

Swift-Cards is an AI-powered flashcard creation tool designed to simplify note-taking and studying. With an intuitive interface and seamless integration of AI, Swift-Cards turns your notes into easy-to-review flashcards. As we continue to enhance the platform, we aim to provide an efficient and user-friendly experience for learning and study management.

Live Demo

Key Features

• AI-Generated Flashcards: Easily create flashcards from your notes using AI. Swift-Cards simplifies complex information into concise, digestible flashcards to streamline studying.
• Account Management and Authentication: Integrated with Clerk for secure user authentication and account management, ensuring a smooth and safe user experience.
• Mock Payment Plans: Learn more about Stripe’s API through mock payment plan implementations. Currently, all payment plans are simulated for educational purposes.

Important Notice

Swift-Cards is currently utilizing Firebase's test environment for authentication and data management. If there's enough interest and support from users, we may scale the platform and enhance its functionality in the future. Please share your feedback with us!

Future Plans

• RAG Integration: We're working on integrating Retrieval-Augmented Generation (RAG) to improve the relevance of flashcard content based on user queries. The integration is in progress, and we hope to release it soon.
• API and Flashcard Generation Improvements: We are addressing issues with flashcard generation and API conflicts, particularly with the system prompt. Your feedback will help us improve these features.

Getting Started

Prerequisites

Ensure you have Node.js and Git installed on your system.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/swift-cards.git

2. Navigate to the project directory:

   cd swift-cards

3. Install dependencies:

   npm install
   # or
   yarn install

4. Create a .env.local file in the root directory with the necessary environment variables:

   NEXT_PUBLIC_API_URL=https://api.example.com
   NEXT_PUBLIC_API_KEY=your_api_key

5. Run the development server:

   npm run dev
   # or
   yarn dev

6. Open http://localhost:3000 with your browser to see the result.

   • You should see the Swift-Cards interface, where you can start generating flashcards.
   • Try creating flashcards by inputting a topic, such as "World History" or "JavaScript basics."

Learn More

To learn more about Swift-Cards and the technologies used, check out the following resources:

• Clerk Documentation - Learn more about user authentication and account management with Clerk.
• Stripe Documentation - Explore Stripe's payment platform and API for processing transactions.
• Next.js Documentation - Get familiar with Next.js features and APIs for building fast web applications.
• Firebase Documentation - Read about Firebase's real-time database, authentication, and other backend services.
• Vercel Deployment Documentation - Find out how to deploy your Next.js apps with Vercel.