Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 1.69 KB

README.md

File metadata and controls

44 lines (37 loc) · 1.69 KB

boggler-flask

A Flask web app for solving the Boggle word game.

Live-demo

It's still a work in progress, but you can check out the live site at https://boggler.cblanken.dev.

Issues

If you notice any bugs while exploring the app please file an issue, so I can fix it. Thanks!

Usage

  1. Submit the board
    • Fill out the board on the home page by clicking on a cell and entering the corresponding letter in your boggle board.
    • The TAB key can used to move to the next cell and SHIFT + TAB navigates to the previous cell.
    • Once the board is filled, click the Solve button at the bottom of the board.
  2. Board and Table Interaction
    • The solved board page will display a table of found words. Click on the table row to show the path on the Boggle board
    • Individual board cells can also be clicked to filter the table to words that pass through that specific cell. The cell will be highlighted in red.
    • To remove the filter, click the button with the filter icon below the board.
    • Click on words in the table to show their path on the board.

Development

  1. Run one of the the startup scripts. Launches the app in debug mode
$ ./boot-dev.sh

Launches the app with gunicorn in production mode

$ ./boot.sh

Navigate to the app at http://localhost:5000.

Docker

If you don't care about live reload you can run the fully containerized app with:

$ sudo FLASK_CONFIG=development docker-compose up 

Then the app should be available at http://localhost This is only recommended for deployment.