Skip to content

WhatsMusic/flashcard-app

Repository files navigation

Flashcard App

This is a Next.js project bootstrapped with create-next-app.

🚀 Getting Started

To run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Then, open http://localhost:3000 in your browser to view the app.

You can start editing the app by modifying the page.tsx file. Changes will be reflected automatically.

✨ Features

  • Create, edit, and manage flashcards.
  • Optimized font loading with next/font using Geist.
  • Built with the power of Next.js for fast and scalable performance.
  • AI-Powered Flashcard Generation: Automatically generate flashcards from text using OpenAI.
  • Interactive Flashcards: Flip through cards, view questions and answers, and navigate easily.
  • Print Functionality: Export flashcards in a printable A4 format, optimized for duplex printing.
  • Responsive Design: Fully functional on both desktop and mobile devices.

📦 Technologies

  • Frontend: React with TypeScript and TailwindCSS for a modern and responsive UI.
  • Backend: Next.js API routes for seamless integration with OpenAI.
  • AI Integration: OpenAI GPT-3.5 for generating flashcards from input text.

📚 Learn More

To learn more about the technologies used in this project:

🛠️ Installation

  1. Clone the repository:
    git clone <repository-url>
  2. Install dependencies:
    npm install
  3. Create a .env file and add your OpenAI API key:
    OPENAI_API_KEY=your-api-key
    
  4. Start the development server:
    npm run dev
  5. Open http://localhost:3000 in your browser.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on the GitHub repository.

🚢 Deployment

Deploy your app easily using the Vercel Platform.

For more details, check out the Next.js deployment documentation.


Made with ❤️ using Next.js and OpenAI.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published