📚 VocaBuilderAI - AI-Powered Vocabulary Builder

Learn vocabulary smarter with AI assistance

Features • Getting Started • Documentation • Screenshots • Support

---

🌟 Features

🤖 AI-Powered Learning

• Auto-complete word details - AI generates definitions, examples, synonyms, antonyms, and emojis
• Smart suggestions - Get contextual learning recommendations
• Grammar assistance - AI explains verb tenses and grammar patterns
• Ask AI feature - Get instant answers while reading

📺 Media-Based Learning

• Learn from Subtitles - Upload .srt or .vtt files from TV shows and movies
• Learn from Books - Read ePub files and extract vocabulary
• Context learning - See words used in real scenarios
• Save media vocabulary - All extracted words stored for practice

🎮 Interactive Practice Games

• Synonyms Flashcards - Match words with similar meanings
• Antonyms Flashcards - Learn opposite words
• Tenses Game - Master verb conjugations with AI feedback
• Mark words - Focus practice on difficult vocabulary
• Track progress - See your improvement over time

🎨 Visual Learning

• Emoji associations - Link words with visual symbols
• Image generation - AI creates relevant images
• GIF search - Animated images for better memory (GIPHY integration)
• Custom organization - Categories and tags

💾 Data Management

• Backup & Restore - Never lose your progress
• Export/Import - Transfer data between devices
• Offline support - Access your vocabulary anytime

---

🚀 Getting Started

Prerequisites

• Flutter 3.38.6 or higher
• Dart 3.10.7 or higher
• Android SDK 36.1.0 (for Android)
• Visual Studio 2026 (for Windows)

Installation

1. Clone the repository

   git clone https://github.com/codomium/VocanuilderAi.git
   cd VocanuilderAi

2. Install dependencies

   flutter pub get

3. Run the app

   flutter run

First Time Setup

1. Get API keys (Free options available):

   • Gemini AI: https://ai.google.dev
   • OpenRouter (free models): https://openrouter.ai
   • GIPHY (optional): https://developers.giphy.com

2. Configure in app:

   • Open Settings → AI Provider
   • Enter your API key
   • Test connection
   • Start learning!

---

📖 Documentation

Quick Links

• Complete User Guide - Comprehensive documentation
• In-App Tutorial - Interactive walkthrough (tap ? icon)
• Settings Help - Tooltips for each feature

Key Documentation Sections

• Getting Started
• AI Configuration
• Creating Words
• Media Learning
• Practice Games
• Troubleshooting

---

🎯 How to Use

Quick Start Guide

1. Setup AI Provider

   • Settings → AI Configuration
   • Choose Gemini or OpenRouter
   • Enter API key

2. Add Your First Word

   • Home → "Add Word"
   • Type word + meaning
   • Let AI auto-complete details ✨
   • Save!

3. Learn from Media

   • Media Center → Subtitles or Books
   • Upload file
   • Read and tap words to save
   • Practice with games

4. Practice Daily

   • Mark difficult words (bookmark icon)
   • Games → Choose Synonyms/Antonyms/Tenses
   • 10 minutes daily = Big progress!

---

📱 Screenshots

Main Features

Home Screen	Settings	Flashcards

Practice Games

Synonyms Game	Antonyms Game	Flashcard Back

Media Learning

Subtitle Learning	ePub Books	Review & Questions

---

🛠️ Built With

• Flutter - UI Framework
• Dart - Programming Language
• Hive - Local Database
• Provider - State Management
• GoRouter - Navigation
• Google Gemini - AI Integration
• OpenRouter - Multi-model AI Access
• GIPHY API - GIF Search

---

🏗️ Architecture

lib/
├── core/
│   ├── constants/      # App constants
│   ├── theme/          # Dark/Light themes
│   └── utils/          # Utilities & services
├── features/
│   ├── home/           # Home page
│   ├── vocabulary/     # Word CRUD operations
│   ├── tutorial/       # Interactive tutorial
│   ├── media/          # Subtitle & book learning
│   ├── games/          # Practice games
│   └── settings/       # App configuration
└── main.dart           # App entry point

---

🆓 Free App

VocaBuilderAI is 100% free to use!

• ✅ No subscription required
• ✅ No in-app purchases
• ✅ Free AI options available (Gemini, OpenRouter free models)
• ✅ All features unlocked

Platform: Android (iOS coming soon based on feedback!)

---

👨‍💻 Author

codomium

• GitHub: @codomium

---

🙏 Acknowledgments

• Thanks to the Flutter community
• Google Gemini team for free AI access
• OpenRouter for multi-model API access
• All contributors and testers

---

📞 Support

Need help? Here's how to get support:

• User Guide: USER_GUIDE.md
• In-App Tutorial: Tap the ? icon on Home screen
• GitHub Issues: Report bugs
• Discussions: Ask questions

---

🗺️ Roadmap

Planned Features

• Cloud sync across devices
• Social features (share word lists)
• Spaced repetition algorithm
• Mobile notifications for practice reminders
• More language support
• Community word lists
• Advanced analytics dashboard

---

⭐ Star History

If you find this project useful, please give it a star! ⭐

---

Made with ❤️ and Flutter

Back to top