/sudokuib

An evolving encyclopedia of sudoku

Apache License 2.0Apache-2.0


An evolving encyclopedia of sudoku


License Variations Twitter


Mission 🚀

To build a collaborative encyclopedia of information on sudoku and its variations.

A meta Instructions Booklet (IB).

Content 📂

This repository hosts the following information on sudoku variations:

  • Title: Name of the sudoku in a clean and case-sensitive format.
  • Rules: Instructions that explain the rules of the sudoku for different grid sizes.
  • Inventor: Name of the person who invented the sudoku variation along with year of invention.
  • Tags: Commonly used attributes for grouping, categorizing and describing the type of sudoku.

Usage 📖

The data is available in json format and can be consumed freely in many ways.
The entire data can be viewed here:

All Sudoku Variations
All Sudoku Tags

Online

The data can be viewed directly on the browser.

https://github.com/vopani/sudokuib/blob/main/variations/arrow.json
https://github.com/vopani/sudokuib/blob/main/variations/classic.json
https://github.com/vopani/sudokuib/blob/main/variations/diagonal.json
...

API

The data can be accessed using GitHub's raw URL.

https://raw.githubusercontent.com/vopani/sudokuib/main/variations/arrow.json
https://raw.githubusercontent.com/vopani/sudokuib/main/variations/classic.json
https://raw.githubusercontent.com/vopani/sudokuib/main/variations/diagonal.json
...

Local

The data can be viewed locally by cloning the repository.

git clone https://github.com/vopani/sudokuib.git
cd sudokuib

Contribution 🛠️

Everyone is welcomed and encouraged to contribute in any way.

💡 New Variation Request

Please request for a new sudoku variation to be added by opening an Issue using the template provided.

💡 Inventor Update

If you know the inventor of any sudoku variation, please open an Issue using the template provided.

💡 Pull Request

You can make data updates yourself too by forking the repo and sending a Pull Request.

💡 Feedback

Please create an Issue for any improvements, ideas, suggestions, errors or feedback about the project.

Feel free to tag @vopani on Twitter for any other queries or feedback.

License 📋

This project is licensed under the Apache License 2.0.