sudocle

A modern web app for Sudoku

Sudocle offers the following features:

• Lightweight and clean look
• Optimised for various devices (mobile and desktop) as well as screens (any
  size and resolution)
• Configurable interface:
  • Themes (including dark mode)
  • Colour palettes (including one optimised for colour blindness)
  • Custom colour palette
  • Zoom
  • Font sizes
  • and other options
• Fully compatible with puzzles published by Cracking the Cryptic
  (see usage instructions below)
• High performance graphics renderer using WebGL or HTML Canvas

Sudocle has been inspired by the official web app of Cracking the Cryptic, the world’s most popular YouTube channel about Sudoku and other logic puzzles.

Using the online version

An online version of Sudocle is available at:

https://michelkraemer.com/sudocle

If you want to play one of the puzzles featured on Cracking the Cryptic in Sudocle, just copy the puzzle’s ID from the CTC webapp and append it to the URL shown above.

For example, the “Miracle Sudoku” by Mitchell Lee, one of the most popular puzzles ever featured on the channel, has the following URL:

https:‎//app.crackingthecryptic.com/tjN9LtrrTL

This URL becomes:

https:‎//michelkraemer.com/sudocle/tjN9LtrrTL

Screenshots

Here are some random screenshots (no spoilers!):

Building and running Sudocle locally

Sudocle requires Node.js v15 or higher. Run the application in development mode with the following commands:

npm install
npm run dev

Open your web browser and go to http://localhost:3000 to open the main page. Just like with the online version, you can append a Cracking the Cryptic puzzle ID to the URL (e.g. http://localhost:3000/tjN9LtrrTL).

Sudocle has been built with Next.js. In development mode, Next.js watches for source code changes and automatically refreshes the application in the browser.

If you want to build Soducle in production mode, use the following command:

npm run build

This will create a directory called out, which you can upload to your web server.

Alternatively, you can run Sudocle with Docker as follows:

docker build -t sudocle .
docker run -it -p 80:3000 --name sudocle --rm sudocle

Then, open http://localhost/sudocle/.

What does “Sudocle” mean?

The name Sudoku is an abbreviation of the Japanese expression “Sūji wa dokushin ni kagiru” (数字は独身に限る), which can be translated to “the digits must be single” [Wikipedia]. Sūji means digits.

A monocle, a binocle, or a pair of binoculars are things that help people see.

Sudocle therefore helps people see digits 🤓😉

License

Sudocle is released under the MIT license. See the LICENSE file for more information.