Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.34 KB

README.md

File metadata and controls

43 lines (30 loc) · 2.34 KB
Raw

Flashily.AI 📝

Demo

See Flashily in action by clicking the image below!

See Flashily in action

Introduction

Welcome to Flashily, the innovative flashcard app powered by OpenAI's GPT API! Flashily aims to simplify and enhance your learning experience by allowing you to effortlessly create flashcards from your documents in just a few clicks.

Features

1. Document Upload

Flashily makes it easy to turn your documents into flashcards. Simply upload your documents in popular formats such as PDF, DOCX, or TXT, and let the app automatically generate relevant flashcards.

2. OpenAI GPT API Integration

We harnessed OpenAI's GPT API along with vector database chroma to create effective flashcards.

3. User-Friendly Interface

Flashily features an intuitive and user-friendly interface. Navigate effortlessly through the app, upload your documents, and create flashcards with just a few clicks.

4. Customization Options

Tailor your flashcards to suit your learning preferences. Customize the content, format, and style of your flashcards to create a personalized learning experience.

5. Audio Playback

Experience a new dimension of learning with Flashily's audio playback feature. Powered by OpenAI's Text-to-Speech (TTS) API, you can now listen to your flashcards in a natural and engaging voice. Enhance your learning by absorbing information through auditory channels, making your study sessions more dynamic and effective. Simply click the 🔈 button and let the power of TTS bring your flashcards to life.

Tech Stack

Backend: FastAPI, LangChain, ChromaDB

Frontend: Svelte, Tailwind CSS, Flowbite

Getting Started

  1. Clone the repository: git clone https://github.com/therealcyberlord/Flashily.AI.git
  2. Install dependencies: npm install for the frontend and python install -r requirements.txt for the backend
  3. Set up your OpenAI API key: Obtain your API key from OpenAI and replace 'YOUR_API_KEY' in the .env file.
  4. Start the app: npm run dev for the frontend and python main.py for the backend
  5. Open your browser and visit http://localhost:3000 to access Flashily.

Happy learning with Flashily!

Made by Xingyu and Gauri