Skip to content

tzada8/sudoku-solver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Sudoku Solver

Sudoku Solver: Solve any Sudoku board with ease

Sudoku Solver provides users with the ability to solve any Sudoku puzzle with ease. Anytime they get stuck on a puzzle and cannot solve the board, this application provides that assistance.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Starting the App
  4. Testing

About The Project

Sudoku Solver Board

Sudoku Solver helps users solve puzzles for them. If no solution exists, the application notifies the user.

Users can either solve the current board or create a new board layout. When creating a board layout, users can insert numbers within each cell of the Sudoku board. Similarly, when solving the current board, users can specify if they are interested in visually seeing the backtracking algorithm in action or if they would prefer to just see the final solution.

Visually displaying the backtracking algorithm will show green and red cells, depicting the cells that were just placed or removed in order to reach the valid solution.

(back to top)

Getting Started

Installations

Ensure the following application is locally installed:

Backend Setup

Follow the steps listed below to setup your backend environment.

  1. Create a local virtual environment
    python3 -m venv .venv
    
  2. Activate the virtual environment
    source .venv/bin/activate
    
  3. When needed, deactivate the local virtual environment
    deactivate
    

(back to top)

Starting the App

Backend Startup

  1. Activate your virtual environment
    source .venv/bin/activate
    
  2. Start the application
    python3 main.py
    

(back to top)

Testing

Backend Tests

  1. Activate your virtual environment
    source .venv/bin/activate
    
  2. Run the tests
    python3 -m unittest discover -s tests
    

(back to top)

About

Solve any Sudoku board with ease

Resources

Stars

Watchers

Forks

Languages