https://github.com/thenameisajay/wordle-game-using-maven-and-tdd-approach

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.
https://github.com/thenameisajay/wordle-game-using-maven-and-tdd-approach

java junit5 learn maven maven-plugin tdd testdrivendevlopment

Last synced: 5 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/thenameisajay/wordle-game-using-maven-and-tdd-approach
• Owner: thenameisajay
• License: mit
• Created: 2023-01-30T11:39:48.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-01T07:09:43.000Z (about 1 year ago)
• Last Synced: 2024-10-11T01:53:57.910Z (27 days ago)
• Topics: java, junit5, learn, maven, maven-plugin, tdd, testdrivendevlopment
• Language: Java
• Homepage:
• Size: 1.83 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 :  

 
 WordleApp.java

 

 GameEngine.java 

 

 RandomEngine.java

 

 WordChecker.java

 

 ScoreEngine.java 

 

 ColorAssigner.java

 

 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:



 Fork the repository



 Create a new branch for your feature or bug fix



 Make your changes and write tests to cover them



 Run  mvn test  to ensure all tests pass



 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.

---