Skip to content

mikesprague/birdle

Repository files navigation

BIRDLE 🐥

Yet another Wordle clone

Features

  • 🔠 Same rules and word lists as original (pre NYT) Wordle
  • 🗄️ Remembers current game status and previous results (stateful via localstorage)
  • 🎨 Dark/light theme based on system setting
  • ⌨️ Supports keyboard bindings if using device with physical KB (laptop/PC/etc)
  • 📱 Progressive Web App (PWA)
    • available offline
    • installable
    • responsive (mobile friendly)
  • 📋 Results sharing
    • uses native sharing on mobile browsers that support it

    • default behavior is to copy results to clipboard

    • results key:

      • absent 🥚
      • present 🐣
      • correct 🐥
    • example results:

        Birdle 12 4/6
      
        🥚🐣🥚🥚🐥
        🥚🥚🥚🐥🐥
        🥚🐣🥚🐥🐥
        🐥🐥🐥🐥🐥
      

Requirements

  • Node.js >= 16.x
  • npm >= 8.x

Getting Started

  1. Clone repo git clone https://github.com/mikesprague/birdle.git
  2. Enter directory cd birdle
  3. Install dependencies npm install
  4. Run project locally npm start
  5. Visit http://localhost:3000 in browser