Skip to content

This project is a Java implementation of the popular word game Wordle, where players have six attempts to guess a five-letter word. The game is built using test-driven development and uses JUnit 5 as the unit-testing framework.

License

Notifications You must be signed in to change notification settings

thenameisajay/Wordle-Game-using-Maven-and-TDD-Approach

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wordle Game using Maven and TDD Approach

DESCRIPTION :

This project is a Java implementation of the popular word game Wordle, where players have six attempts to guess a five-letter word. The game is built using test-driven development and uses Junit 5 as the unit-testing framework. The code is built and tests are run using the Maven configuration file and commands.


Files in the application:

    Main File :
  1. WordleApp.java
  2. GameEngine.java
  3. RandomEngine.java
  4. WordChecker.java
  5. ScoreEngine.java
  6. ColorAssigner.java
  7. WordleGridLayout.java

INSTALLATION

  1. Clone the repository (or)
  2. Extract the *.zip file.
  3. Navigate to the src folder of the Program.
  4. Compile the .java files in terminal
  5. Also clean mvn clean and package mvn package using maven to generate .jar file
  6. Run WordleApp.java to generate the Command Line Interface.

This will compile the code and generate a jar file in the target directory.


Usage :

To play Wordle, run the following command:
java -jar target/filename.jar
The game will select a random word from the provided wordlist and prompt the user to make a guess. The user has six attempts to guess the word. After each guess, the game will display the appropriate feedback to the user. The game ends when the user correctly guesses the word or runs out of attempts. At the end of the game, the user's score is displayed.


CONTRIBUTING

If you would like to contribute to Wordle, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Make your changes and write tests to cover them
  4. Run mvn test to ensure all tests pass
  5. Submit a pull request

JUnit Tests : JUnit Test built for the application run on JUnit5.

Test Files :

  1. ClassLoaderTest.java
  2. GameEngineTest.java
  3. RandomEngineTest.java
  4. ScoreEngineTest.java
  5. WordCheckerTest.java

LICENSE :

This project is licensed under the MIT License. See the LICENSE file for more information.

About

This project is a Java implementation of the popular word game Wordle, where players have six attempts to guess a five-letter word. The game is built using test-driven development and uses JUnit 5 as the unit-testing framework.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages