Simple hangman game that can be played via web or JSON API.
- Chooses a random word out of 6 words: [3dhubs, marvin, print, filament, order, layer]
- Display the spaces for the letters of the word (eg: '_ _ _ _ _' for 'order')
- The user can choose a letter and if that letter exists in the chosen word it should be shown on the puzzle (eg: asks for 'r' and now it shows '_ r _ _ r' for 'order')
- The user can only ask 5 letters that don't exist in the word and then it's game overIf the user wins, congratulate the user and save their high score (you are free to define what is a “high score”)
- Provide a simple API for clients to play the game
- Provide an interface for users to play the game
- Class based views are used so code can easily be shared between API and HTML template views.
- Postgres database is used to store game state and high scores.
- For convenience sake, secrets have been commited to git as environmental variables in dokcer-compose file.
- Letters are case-insensitive.
Appending '/api' to any endpoint will return JSON and also accept it for POST requests. For example GET /game will return
a rendered template and GET /game/api/ will return JSON.
GET /# Returns registration form.POST /# AcceptsusernameGET /game# Returns current state of game based on current user set in session cookie.POST /game# Acceptsletterparameter.GET /reset# Resets the game for the current user.GET /high-scores# Lists high scores.
- Flask
- SQLAlchemy
- Pytest
- Postgres
- Bootstrap
- Docker
git clone [email protected]:paul-rchds/hangman.git
docker-compose up
# Browse to http://127.0.0.1:8080docker-compose up -d
docker ps # Get container_id
docker exec <container_id> pytest -v
- In hindsight the views could have been simpler if they only implemented a JSON API and some front-end code was used to submit forms and get data.
- I should have used migrations to track changes to the database.
- Unit tests could be added.