README.md

wordle-nicht

Try it out!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running the Project
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a German implementation of the word game "Don't Wordle", a variation of "Wordle", where it is your goal to NOT find the daily solution.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

You can play "wordle nicht!" on its Github Pages site.

To get a local copy up and running follow these simple steps.

Prerequisites

This project runs on a node.js backend. If you haven't already, please install npm to run it.

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/DRovara/wordle-nicht.git

2. Install NPM packages

   npm install

After completing these steps, the node server will be ready to be run locally.

Running the Project

You can run a development version of the project by running

    npm run dev

Alternatively, you can build and run wordle nicht! using

    npm run build
    npm run start

After running the development or release version of wordle nicht!, you can access it through your browser on localhost:3000.

(back to top)

Usage

In wordle nicht! it is your goal to enter six guess words consisting of five letters each without accidentally entering the secret solution word. However, there is a catch: After each guess, letters are marked to indicate their role in the result:

• green letters appear in the solution at exactly the same place.
• amber letters appear in the solution but at a different place.
• grey letters do not appear in the solution at all.

Once the game has informed you of the role of a letter, all further guesses you make must conform to these roles. For instance, if your guess contains the letter e on the fourth position and it is marked green, all further guesses must include an e on that position. On the other hand, if your guess contains the latter a on the second position and it is marked amber, all further guesses must include the letter a and you are no longer allowed to enter guesses with an a at position two.

In order to prevent unfortunate guesses that are very similar to the solution from ruining the game, you are allowed to undo five of your guesses each game using the "UPS" button. This allows you to provide other guesses, acting as if you had never entered the undone word.

Contributing

Any contributions you make are appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/DRovara/wordle-nicht

(back to top)