FlashyGen is a flashcard generation tool that allows users to create flashcards from various input sources, including text, PDF, PPTX, DOCX, and CSV files. This project is powered by FastAPI for the backend and deployed on Vercel for the frontend.
- Generate flashcards from different file formats and raw text.
- Supports PDF, PPTX, DOCX, CSV, and plain text inputs.
- Easy-to-use interface for flashcard generation.
- Backend: FastAPI
- Frontend: HTML, CSS (deployed on Vercel)
- Text Extraction Libraries: PyPDF2, python-pptx, python-docx, and csv
- Environment Management: dotenv
- Generative AI: LangChain
- Deployment: Vercel for the frontend, FastAPI for the backend
To run the project locally, follow these steps:
- Python 3.7 or higher
- Node.js and npm (for Vercel deployment)
- A Groq API key (sign up for access if needed)
git clone https://github.com/devroopsaha744/mermory-ai.git
cd mermory-aiNavigate to the backend directory and install the required packages:
cd backend # Update this if your backend is in a different folder
pip install -r requirements.txtCreate a .env file in the backend directory and add your Groq API key:
GROQ_API_KEY=your_api_key_here
Start the FastAPI server:
uvicorn main:app --host 0.0.0.0 --port 8000 --reload-
Install the Vercel CLI if you haven't already:
npm install -g vercel
-
Navigate to your frontend directory and deploy:
cd frontend # Update this if your frontend is in a different folder vercel
Refer to the "api_docs.md" file for detailed information about the available endpoints and how to use them.
Contributions are welcome! Please follow these steps to contribute to the project:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit them (
git commit -m 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Create a pull request.
This project is licensed under the MIT License. See the LICENSE file for more details.