Skip to content

Latest commit

Β 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AhoMINNA - Japanese Learning Plugin for WordPress

Version WordPress PHP License

A comprehensive WordPress plugin for teaching Japanese with Minna no Nihongo textbook (50 lessons) designed specifically for Vietnamese learners.

πŸ“š Features

Learning Sections

  • Vocabulary (Tα»« vα»±ng): Interactive flashcard system with flip animations
  • Grammar (Ngα»― phΓ‘p): Structured grammar patterns with Vietnamese explanations
  • Dialogue (Hα»™i thoαΊ‘i): Conversation practice with audio and video support
  • Quiz (TrαΊ―c nghiệm): Multiple-choice quizzes with instant feedback

Key Functionalities

  • 🎴 Flashcard System: Learn and review mode with swipe/click navigation
  • 🎡 Audio Support: Japanese pronunciation for vocabulary and dialogues
  • πŸŽ₯ Video Integration: YouTube embed or direct video upload
  • πŸ“Š Progress Tracking: Save user progress for each lesson section
  • 🎯 Quiz System: Track scores and review answers with explanations
  • πŸ“± Responsive Design: Optimized for desktop, tablet, and mobile
  • πŸ–₯️ Fullscreen Mode: Presentation-ready with keyboard shortcuts
  • 🌐 Bilingual: Japanese-Vietnamese interface

Admin Features

  • Custom post types for lessons, vocabulary, grammar, dialogues, and quizzes
  • Bulk import from CSV for vocabulary and quiz questions
  • Visual dashboard with statistics
  • Easy content management with custom meta boxes
  • Settings page for plugin configuration

πŸš€ Installation

  1. Upload the ahominna folder to /wp-content/plugins/ directory
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Navigate to AhoMINNA in the admin menu
  4. Start creating lessons!

πŸ“‹ Requirements

  • WordPress 5.0 or higher
  • PHP 7.4 or higher
  • Modern web browser with JavaScript enabled

πŸŽ“ Usage

Creating Lessons

  1. Go to AhoMINNA > Add New Lesson
  2. Enter lesson title, number, and description
  3. Create vocabulary, grammar, dialogues, and quizzes
  4. Link them to the lesson using IDs

Bulk Import

  1. Go to AhoMINNA > Import
  2. Select import type (Vocabulary or Quiz)
  3. Choose CSV file with correct format
  4. Upload and import

Vocabulary CSV Format

kanji,hiragana,romaji,vietnamese,image_url,audio_url
ε­¦η”Ÿ,γŒγγ›γ„,gakusei,học sinh,https://example.com/image.jpg,https://example.com/audio.mp3

Quiz CSV Format

question,type,option_a,option_b,option_c,option_d,correct_index,explanation,audio_url
Question text,vocabulary,Option A,Option B,Option C,Option D,0,Explanation here,

Shortcodes

Display lessons on any page or post:

[ahominna_lessons]

Display a specific lesson:

[ahominna_lesson id="1"]

Display vocabulary flashcards:

[ahominna_vocabulary lesson="1"]

Display quiz:

[ahominna_quiz lesson="1"]

🎨 Customization

CSS Customization

Override styles by adding custom CSS in your theme:

.ahominna-lesson-container {
    /* Your custom styles */
}

Color Scheme

Edit /public/css/style.css to change the color variables:

:root {
    --primary-color: #e74c3c;
    --secondary-color: #3498db;
    --accent-color: #f39c12;
}

⌨️ Keyboard Shortcuts

Flashcard Mode

  • ← Previous card
  • β†’ Next card
  • Space Flip card

Quiz Mode

  • ← Previous question
  • β†’ Next question
  • Enter Submit quiz

Fullscreen Mode

  • Esc Exit fullscreen
  • Shift + ← Previous section
  • Shift + β†’ Next section

πŸ“± Responsive Design

The plugin is fully responsive and optimized for:

  • Desktop (1200px+)
  • Tablet (768px - 1199px)
  • Mobile (< 768px)
  • Landscape mode

πŸ”§ Technical Details

Custom Post Types

  • ahominna_lesson - Lessons
  • ahominna_vocabulary - Vocabulary items
  • ahominna_grammar - Grammar patterns
  • ahominna_dialogue - Conversation dialogues
  • ahominna_quiz - Quiz questions

Database Tables

  • {prefix}_ahominna_progress - User progress tracking
  • {prefix}_ahominna_quiz_results - Quiz results

AJAX Actions

  • ahominna_save_progress - Save learning progress
  • ahominna_submit_quiz - Submit quiz answers
  • ahominna_get_vocabulary - Fetch vocabulary data

🌍 Internationalization

The plugin is translation-ready. Translation files are located in /languages/ directory.

Current languages:

  • English (default)
  • Vietnamese (vi)

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

πŸ“ License

This plugin is licensed under the GPL v2 or later.

πŸ‘¨β€πŸ’» Author

DatNong

πŸ“ž Support

For support, please open an issue on the GitHub repository.

🎯 Roadmap

  • Mobile app integration
  • Additional quiz types (fill-in-the-blank, matching)
  • Gamification features (badges, streaks)
  • Social sharing
  • Export progress reports
  • Lesson completion certificates

πŸ“Έ Screenshots

Screenshots will be available in the /assets/ directory.

⚑ Performance

  • Lazy loading for images
  • Optimized CSS and JavaScript
  • Minimal database queries
  • Caching support

πŸ”’ Security

  • CSRF protection with nonces
  • Input sanitization and validation
  • Prepared SQL statements
  • Capability checks for admin functions

πŸ“š Documentation

For detailed documentation, visit the Wiki.


Made with ❀️ for Japanese language learners in Vietnam

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages