Deck is a productivity application designed to enhance your learning and task management experience. With Deck, you can create custom flashcards, generate flashcards automatically using Gemini AI 🤖, and efficiently manage your tasks. It's the perfect tool for students, professionals, and anyone looking to boost their productivity.
- Manual Creation ✏️: Create flashcards tailored to your specific needs.
- 📄 PDF Upload Support: Upload PDFs as study material to automatically generate flashcards.
- 🤖 AI-Generated Flashcards: Automatically generate flashcards from your study materials by uploading PDFs or using the AI generator.
- 🧑🎓 User-Friendly Interface: Simple and intuitive UI to interact with your study content.
- 🎯 Personalized Learning: AI adapts flashcards to ensure relevance for your uploaded content.
- 📋 Organize Tasks: Add and track tasks to ensure efficient workflow.
- 🚀 Productivity Boost: Integrate task management with flashcards to enhance study sessions.
- 📱 Android device
- 🌐 Internet connection for AI-generated flashcards
-
Clone the repository
git clone https://github.com/majiinB/Deck-V2.git cd <project-directory>
-
Install dependencies
flutter pub get
-
Set up the backend API
- The backend API for Deck is hosted in the Deck-API repository. Refer to that repository for further setup instructions.
-
Run the Flutter app
flutter run
- Navigate to the Flashcards section.
- Choose to create flashcards manually or use the AI generator.
- For manual creation, input your term/question and description/answer.
- For AI generation, fill out the topic, subject, or description textbox. You can even upload a PDF file and let the AI do the work.
- Navigate to the Tasks section.
- Add a new task by tapping the "+" button.
- Set the task's priority and due date.
- Track and manage your tasks to stay organized.
- Flutter 🖥️: Frontend mobile app framework.
- Dart 💻: Programming language for Flutter.
- Gemini AI 🤖: Core AI for generating flashcards from PDFs.
- Node.js 🌐: Backend for processing uploads and connecting with the AI.
- Firebase 🔥: Used for backend services and data management.
We welcome contributions from the community! To contribute:
- Fork the repository 🍴
- Create a new branch 🛤️:
git checkout -b feature/YourFeature
- Commit your changes 📝:
git commit -m 'Add some feature' - Push to the branch ⬆️:
git push origin feature/YourFeature
- Open a Pull Request 📬
Deck is licensed under the MIT License - see the LICENSE file for details.
If you have any questions or suggestions, feel free to open an issue or contact us at [email protected]
Thank you for using Deck! We hope it helps you achieve your productivity goals! 🎉