Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 2.32 KB

README.md

File metadata and controls

108 lines (72 loc) · 2.32 KB
Raw

About the Project

This is a project done when I was attending the Full-Stack coding bootcamp at Concordia University

Running The Project

Run yarn install followed by yarn dev

Stack

This projects has been done with vanilla JS, CSS in the FE. The backend is done in Node with Express

What has been implemented

  • The answer is never exposed to the client

  • A dataset containing 20 words, including a hint to make it easier to guess the word. If the user clicks on the hint, they will lose 1 point

  • Score, starting at 10. Each miss will have the user lose 1 point.

  • Autofocus and form reset once user submits the letter

  • If user wins, the name of the word correctly guessed is displayed as well as a winning message

  • If user loses, a losing message is displayed

  • Created 2 main endpoints in a way that the word is never exposed to the frontend

  • Added a middleware to validate the "wordId" input coming from the FE

  • Added a favicon to the page

  • Misses DIV to let the user know what guesses were misses

  • Disabled HTML form input autocomplete and autofill for better UX

Endpoints

Words

GET
/api/v1/hangman/:wordId

Given a valid id, it returns an object with the word letterCount as well as the hint. Valid IDs range from 120 to 140.

{
  "letterCount": "5",
  "hint": "fruit"
}

If ID is incorrect or invalid, it returns the following:

{
  error: "Please enter a valid ID";
}

Attributes

letterCount => string
hint => string

Guess Per Letter

GET
/api/v1/hangman/guess/:wordId/:letter

Returns an object with the letterCount as well as the indexes of an array which should be set to true:

{
  "letterCount": 5,
  "trueIndexes": [
    1,
    2
  ]
}

With that, once the array in the client and the word in the server have the same length and all values in the array are true, the word will have been guessed.

Attributes

letterCount => integer
trueIndexes => list

Demo

Winning flow

Losing Flow