Code Monkey home page Code Monkey logo

boggler-flask's Introduction

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.

boggler-flask's People

Contributors

cblanken avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

 avatar

boggler-flask's Issues

Add dark mode toggle

Add necessary light and dark styles and animated toggle button to switch between each mode.

Word letter heatmap for solved boards

  • Add board heat map feature to display the most used letters on a solved board.
  • Probably want to use a gradient from green -> yellow -> orange -> red
  • May also use a number in the corner of each cell to indicate the exact letter usage count

Add filter for words that start with a particular block

  • Maybe add count indicators like for the heatmap (total counts for a block)
  • It might make sense to make the Heatmap configurable to select for total word count / words that begin with the selected block / words that end with the selected block

Tutorial / info overlay

Add a short tutorial (in text) or an animated introduction to the solver and solved pages.

Little info popups on hover or by clicking an icon might be a good alternative as well.

Redesign board controls for better UX on desktop and mobile

  • Size and Max Word Length inputs should use a stepper and Dictionary
    img1

  • Dice selections can either remain select and be restyled or vertically segmented buttons
    img2

  • The Randomize button should be isolated and maybe attached to the board and restyled to distinguish it from the Solve button

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.