Skip to content

a Cantonese version of WORDLE which guess Chinese idiom (四字成語) in 6 guesses

Notifications You must be signed in to change notification settings

Walter0697/Candle

Repository files navigation

🕯️ Candle

GitHub stars GitHub forks GitHub license GitHub last commit GitHub issues GitHub pull requests

A Cantonese version of WORDLE that challenges you to guess Chinese idioms (四字成語) in 6 guesses! 🔥

🎮 How to Play

  • Guess a 4-character Chinese idiom in 6 attempts
  • Each guess must be a valid Cantonese idiom
  • Get color-coded feedback to help you solve the puzzle
  • Green = correct character in correct position
  • Yellow = correct character in wrong position
  • Gray = character not in the word

✨ Features

  • 🎯 Daily Puzzles: New idiom challenge every day
  • 📱 PWA Support: Install as a mobile app
  • 🎨 Beautiful UI: Smooth animations with React Spring
  • 📊 Statistics: Track your solving performance
  • 🔄 Auto Updates: Dictionary automatically updates from rime-cantonese
  • 🌐 Responsive: Works on desktop and mobile

🛠️ Technologies

  • React 17 - Frontend framework
  • PWA - Progressive Web App capabilities
  • React Spring - Smooth animations
  • Material-UI - Modern UI components
  • Redux Toolkit - State management

🚀 Getting Started

Prerequisites

  • Node.js 16+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/Walter0697/Candle.git

# Navigate to the project directory
cd Candle

# Install dependencies
npm install

# Start the development server
npm start

The app will be available at http://localhost:9090

📚 Dictionary Sources

This project uses data from:

  • rime-cantonese - Main source for Cantonese pronunciation data
  • Custom word bank - Curated collection of Chinese idioms

The dictionary is automatically updated daily via GitHub Actions to ensure the latest entries are available.

🤝 Contributing

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

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Inspired by the original WORDLE game
  • Dictionary data provided by rime-cantonese
  • Built with ❤️ for the Cantonese-speaking community

Made with 🔥 by Walter0697

About

a Cantonese version of WORDLE which guess Chinese idiom (四字成語) in 6 guesses

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages