Skip to content

Overview & Quick Start

Undoku is a high-performance Sudoku puzzle generator, cognitive solver, difficulty evaluator, Web Canvas game, and Express.js REST API engine. It generates uniquely solvable Sudoku boards with step-by-step logical deduction provenance and fine-grained difficulty scoring.

  • Node.js: Version 18.0+ (LTS recommended)
  • npm: Version 9.0+

1. Launch the Web Application & Express.js Server

Section titled “1. Launch the Web Application & Express.js Server”

Launch the unified Express.js server with integrated generator, evaluators, and SVG rendering on port 8080:

Terminal window
npm start
# or from server directory:
cd server && npm start

Once running, visit http://localhost:8080 in your browser to play the game!

2. Running the Interactive Documentation Wiki Locally

Section titled “2. Running the Interactive Documentation Wiki Locally”
Terminal window
npm run dev
# or from wiki directory:
cd wiki && npm run dev
Terminal window
npm run build

Run the complete test suite covering the Express.js REST API, SQLite storage layer, SudokuEngine mathematical solver, and SVG vector rendering:

Terminal window
npm test