wordle-clone

Click here to play

A clone of the worldwide phenomenon known as Wordle.

Can be played on either the browser or the command line.

Setup

Browser

Click here to play on the browser

CLI

Clone this repository, then run the following:

npm install --production

Then run the following to link it to your PATH:

npm link

Now you can run it using the following command:

wordle

Features

• Base game
  • Browser version
  • CLI version
• Share functionality
• Countdown to next day's Wordle
• Hard Mode

Development

Clone this repository, then run the following:

npm install

It's also a good idea to scramble the words when working on the project, to prevent spoilers:

./scripts/gen_word_list.sh

(Note: If you're on Windows, run the script in WSL)

The following will make it so that git doesn't detect that words.txt changed:

git update-index --assume-unchanged words.txt

At this point, you can run a local web server on the project directory, and the game should render when navigating to the port of the server from your browser.

Testing

Run the following to launch unit tests:

npm run test

Cypress tests can be accessed by running the following:

npm run cypress open

This will launch the tests in the Cypress UI.

Alternatively, you can run the tests directly on CLI:

npm run cypress run

Future Additions

• Player Statistics
• Archive
• Animations
• Code cleanup