Skip to content

MaxBetich/wordle-app

Repository files navigation

A Nightmare on (Word)le Street

By Laura Hope, Max Betich, Ross Davila, Joe Wilfong & Eusebie Siebenberg

A very spooky Wordle Clone

Technologies Used

  • HTML
  • CSS
  • JavaScript
  • Webpack v4.46.0
  • Node.js v16.13.1
  • Babel v7.18.6

Description

This application demonstrates using 2 different APIs, one from Random-Word-API and one from DictionaryAPI, to generate a wordle-simulation game. The APIs return parsed JSON data to the user for random 5-letter word generation and correct dictionary defintion of the word. Directions for the game are as follows:

  • Begin by clicking "New Game" button
  • A random 5-letter word has now been generated
  • Use the onscreen keyboard to make your guesses, 6 guesses total
  • Type word into the wordle cell rows
  • Hit "enter" to submit guess
  • Cells will flip yellow if correct letter is guessed but in the wrong spot, green if correct letter in the correct spot, or remain grey if not included in the hidden word
  • A modal will pop up either once you have guessed the right word, or once you had run out of guesses
  • Modal will include correct word and its definition according to DictionaryAPI
  • Try not to be scared!

Setup/Installation Requirements

  • Clone “wordle-app“ from the repository to your desktop
  • Navigate to "wordle-app" directory via your local terminal command line
  • Open the directory in VS code by typing 'code .' in the command line
  • Run 'npm install' in the command line to install all packages
  • Run 'npm run build' to build the project via webpack
  • Run 'npm run lint' to lint all JS files
  • Run 'npm run test' to test files via Jest
  • Run 'npm run start' to start a development server

Known Bugs

  • The second and subsequent time the "New Game" button is clicked to generate a new instance of the wordle game without refreshing the page, the application will display the Error modal popup upon entering a word, regardless if the word is valid or not. Re-entering the same word again, or another word, will cause the application to continue functioning normally.

License

See attached License.txt file for MIT licensure description

Copyright (c) [2023] [Laura Hope, Max Betich, Ross Davila, Joe Wilfong & Eusebie Siebenberg]

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published