A web app to play everyone's favorite 9x9 game, Sudoku!
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
A simple web app that generates a solvable Sudoku grid.
The app was built using React and TypeScript:
To get a local copy up and running follow these simple example steps.
The following items are required to begin installation and correctly run the code
- Node.js v16.6.0
- npm
-
Clone the repo
git clone https://github.com/rbondoc96/sudoku
-
Install npm packages
In the
srcfolder, runnpm installto install dependencies/src $ npm install
To start the frontend dev server, use npm run dev-server
/src $ npm run dev-serverGiven a certain number of clues, the app generates a Sudoku grid.
As an aiding feature, the grid will highlight all cells (rows, columns, and subgrid) that the current input cell is affecting.
If the user is stuck, they have the option to reveal a hint. The grid chooses a random, empty cell and reveals the value that belongs in that cell.
To solve the grid, the app will either:
- Check every cell in the grid and compare it with the solution grid
- Validate that the entire grid is a valid Sudoku
A true Sudoku game has a single unique solution. In the event that the generated Sudoku grid has more than 1 solution, the app validates the entire grid.
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
Any contributions you make are greatly appreciated!
- Fork the project
- Create a new branch (
git checkout -b feature/MyFeature) - Commit your changes (
git commit -m 'Added MyFeature') - Push to the branch (
git push origin feature/MyFeature) - Open a pull request
Distributed under the MIT License. See LICENSE for more information.
Rodrigo Bondoc - [email protected]
Project Link - https://github.com/rbondoc96/sudoku