https://github.com/mysteryblokhed/wordle-finder

A site to add generic wordlists for Wordle-like games and find solutions for a given date. Mirrored from https://gitlab.com/MysteryBlokHed/wordle-finder
https://github.com/mysteryblokhed/wordle-finder

Last synced: about 1 month ago
JSON representation

A site to add generic wordlists for Wordle-like games and find solutions for a given date. Mirrored from https://gitlab.com/MysteryBlokHed/wordle-finder

• Host: GitHub
• URL: https://github.com/mysteryblokhed/wordle-finder
• Owner: MysteryBlokHed
• License: agpl-3.0
• Created: 2022-12-17T02:35:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-02T22:07:38.000Z (8 months ago)
• Last Synced: 2024-04-28T03:19:02.759Z (7 months ago)
• Language: TypeScript
• Homepage: https://wordle.adamts.me
• Size: 612 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wordle Finder

A site to add generic wordlists for Wordle-like games and find solutions for a given date.

## Use

Usage is documented on the website itself and can be found by pressing the "Help" button at the bottom.

## Building

Yarn is used to build the project.

To install dependencies, run:

```sh

yarn install

```

To start a development server, run:

```sh

yarn dev

```

To build for production, run:

```sh

yarn build

```

## Contrubuting

### Adding builtin wordlists

Builtin wordlists are compressed using lz-string to reduce bundle size.

Here's how to compress and add a list:

1. Save the wordlist to a file containing a JSON array`

   ```jsonc

   // list.json

   ["flame", "brick" /* etc */]

   ```

2. Run the `compress-list` script

   ```sh

   yarn compress-list list.json

   ```

3. Copy the outputted base 64 (also saved to a file ending in `.compressed`)

4. Add an entry to the `PRESET_LISTS` constant in `src/lists.ts`

   ```typescript

   const PRESET_LISTS = {

     // ...

     'Some List': decompress('NoIgZgNghgtgpiANCARgJwJYGMDWIC6QA==='),

   }

   ```

## License

This project is licensed under the GNU Affero General Public License, Version 3.0

([LICENSE](LICENSE) or ).