Skip to content

kaikaijiang/worblebu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Worblebu πŸŒ²πŸ“š

A fun, interactive German vocabulary learning app for primary school children. Built with React and Vite.

▢️ Live Demo

React Vite License


✨ Features

πŸ“– Learn Words Mode

Browse vocabulary as interactive flashcards:

  • Front: German word with article + example sentence
  • Back: Chinese translation + grammar details
  • Color-coded articles: πŸ”΅ der | πŸ”΄ die | 🟒 das

🎴 Practice Flashcards Mode

Test your German spelling:

  • Front: Partially hidden word (e.g., F__rz__g) + context sentence
  • Back: Full word + grammar details (no translations!)
  • 50% of characters hidden randomly each session

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm

Installation

# Clone the repository
git clone https://github.com/kaikaijiang/worblebu.git
cd worblebu

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:5173 in your browser.

Build for Production

npm run build
npm run preview  # Preview the production build

πŸ“ Project Structure

worblebu/
β”œβ”€β”€ public/
β”‚   └── A1.json              # Vocabulary data (Level A1)
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ assets/
β”‚   β”‚   └── background.png   # Fantasy forest background
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”œβ”€β”€ Home.jsx         # Landing page
β”‚   β”‚   β”œβ”€β”€ LevelSelector.jsx
β”‚   β”‚   β”œβ”€β”€ CardViewer.jsx   # Learn mode cards
β”‚   β”‚   └── FlashCard.jsx    # Practice mode cards
β”‚   β”œβ”€β”€ App.jsx
β”‚   └── App.css
└── .github/
    └── workflows/
        └── deploy.yml       # GitHub Actions deployment

πŸ“Š Data Format

Vocabulary is stored in JSON files per level (A1.json, A2.json, etc.):

{
  "Fahrzeug": {
    "cn": "车辆",
    "type": "norm",
    "example": "Das Fahrzeug fΓ€hrt schnell.",
    "grammar": {
      "article": "das",
      "plural": "Fahrzeuge"
    }
  }
}

Word Types

Type Description
norm Nouns (with article & plural)
verb Verbs (with conjugation)
adjektive Adjectives (with comparative/superlative)
adverb, pronomen, anderen Other word types

🎨 Design

  • Target: Primary school children + adults
  • Theme: Playful fantasy forest with teal/green palette
  • Font: Nunito (rounded, friendly)
  • Responsive: Works on iPad, tablet, phone, and desktop

🚒 Deployment

This project auto-deploys to GitHub Pages via GitHub Actions on every push to main.

Manual Deployment

  1. Push to GitHub
  2. Go to Settings β†’ Pages β†’ Source and select GitHub Actions
  3. Site will be live at https://<username>.github.io/worblebu/

πŸ› οΈ Tech Stack

Layer Technology
Framework React 19
Build Tool Vite 7
Styling Vanilla CSS
Deployment GitHub Pages

πŸ“ License

MIT License - feel free to use and modify!


πŸ™ Acknowledgments

  • Background artwork: Fantasy forest theme
  • Font: Nunito by Vernon Adams

About

🌲 Fun German vocabulary learning app for kids - Learn and practice with interactive flashcards

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors