README.md

Wordle

A small clone of the popular word guessing game Wordle.

Gameplay

The goal of the game is to guess a secret 5-letter word in at most six tries. After every guess, each letter is marked as either green, yellow or gray:

• green indicates that letter is correct and in the correct position
• yellow means it is in the answer but not in the right position
• gray indicates the letter is not in the answer at all

Rules

Each guess must be a valid 5-letter word.

🚀 Getting started

If you want to play around with the code yourself - feel free to do so 🧑🏻‍💻. First clone the project using

git clone https://github.com/florianbuehler/wordle.git

(or alternatively using SSH and [email protected]:florianbuehler/wordle.git) and then navigate into the root folder of the project and run

npm install

to install the required packages into the node_modules folder.

🔧 Development

Start the development server with hot reload configured with

npm run dev

and then navigate to http://localhost:3000 in your browser to view the latest changes.

To help ensuring some basic formatting and code quality standards, the project has prettier and eslint configured. That's why you can simply use

npm run eslint

to see if the code matches the standards and run

npm run fix-eslint

to let eslint fix it automatically where possible.

💫 Deployment

Build an optimized and production ready version of the project with

npm run build

The production build is located in the ./build directory and can be served with a static file server. E.g. by running

serve -s build

Note: To be able to use serve it must be installed on your machine. If you haven't done so yet, you can install it with

npm install -g serve