Wizdle.Models 1.0.2

<p align="center"><img src="Resources/title.png" alt="Wizdle" width="512" height="512"></p>

🔭 High Level

A library for solving Wordle.

Simple Flow:

---
config:
  theme: redux-dark
  look: handDrawn
  layout: fixed
---
flowchart LR
    CORRECT["Correct Letters"] --> REQUEST["Request"]
    MISPLACED["Misplaced Letters"] --> REQUEST
    EXCLUDE["Excluded Letters"] --> REQUEST
    REQUEST --> ENGINE["Engine"]
    ENGINE --> RESPONSE["Response"]
    RESPONSE --> WORDS["Possible Words"]

Prerequisites

🧙 Wizdle

The Wizdle core library found here, is responsbile for translating the request into a list of possible Words.

Example

var wizdleEngine = new WizdleEngine(logger);

var request = new WizdleRequest
{
    CorrectLetters = "....t"
    MisplacedLetters = "..rs.",
    ExcludeLetters = "haebu",
};

WizdleResponse response = wizdleEngine.ProcessWizdleRequest(request);
// response.Words: ["skirt", "snort", "sport"]

Package

Available on:

• NuGet
• GitHub

💻 Wizdle.Console

The Wizdle Console application allows us to access all the functionality of the Wizdle library via the CLI.

More information can be found here

Example

Command:

$ ./Wizdle.Console.exe solve --correct "....t" --misplaced "..rs." --exclude "haebu"

Response:

Processing WizdleRequest: CorrectLetters: "....t"   MisplacedLetters: "..rs." ExcludeLetters: "haebu"
Mapping WizdleRequest:    CorrectLetters: "....t"   MisplacedLetters: "..rs." ExcludeLetters: "haebu"
Mapped SolveParameters:   CorrectLetters: "????t"   MisplacedLetters: "??rs?" ExcludeLetters: "haebu"
Found 3          Word(s) matching the criteria.
Found 3 Word(s) matching the criteria.
skirt
snort
sport

🪟 Wizdle.Wpf

The Wizdle WPF application allows us to access all the functionality of the Wizdle library via a GUI on Windows.

More information (and installers) can be found here.

📨 Wizdle.Api

The Wizdle Api Service contains a deployable API instance of the Wizdle library.

More information can be found here

🎯 POST

Summary: Processes a Wizdle request in an attempt to solve the possible words.

Request

Content-Type: application/json

Body Parameters

Example:

{
    "correctLetters": "a__le",
    "misplacedLetters": "t",
    "excludeLetters": "xyz"
}

Response

Status Code: 200 OK

Body

Example:

{
    "messages": ["Found 2 Word(s) matching the criteria."],
    "words": ["apple", "angle"]
}

📲 Wizdle.Web

The Wizdle Web contains a deployable Blazor web app instance of the Wizdle library (hosted on the new dotnet Aspire platform & Docker).

More information can be found here

🤖 Wizdle.Discord

A Discord bot hosting all the functionality of the Wizdle library, users can integrate the bot into their Discord servers.

Invite link for Discord.

🧪 Testing

• Unit Testing
  • Wizdle.Unit.Tests
• Integration Testing
  • Wizdle.Integration.Tests
• Functional Testing
  • Wizdle.Api.Functional.Tests
  • Wizdle.Web.Functional.Tests (using Playwright)
• Performance Testing
  • Wizdle.Performance.Tests (using BenchmarkDotNet)
• Accessibility Testing
  • Wizdle.Web.Functional.Tests (using axe-core)
• Mutation Testing
  • Strkyer.NET with my GitHub Action

⚙️ Make

This project includes a Makefile to simplify common development tasks. Run make help to see all available commands.

Available Commands

Quick Start

1. Build the solution:

   make build
   

2. Run tests:

   make test
   

3. Generate tokens for your .env file:

   make token
   

4. Build all Docker images:

   make build-all
   

5. Start all services:

   make compose
   

6. View logs:

   make logs
   

7. Stop services:

   make stop
   

TL;DR for the TL;DR

Lyndon, did you just spend all this time working on a tool to cheat wordle... rather than actually just solving the word?!