Shadify

Focus on creating incredible and beautiful applications without worrying about complicated logic.

Quick overview

Shadify is a powerful API for generating data and executing various logic to create different applications and games. It uses HTTP requests to interact with the service and returns convenient JSON responses. Shadify can be very useful for developers who do Frontend-development. With the modules already available, you can focus entirely on creating beautiful UIs for applications that will enrich your portfolio.

The codebase is written in the Go programming language, which is great for creating server-side applications, as well as providing high computational power.

Documentation

Доступно на русском

The service is divided into independent modules. Each module starts with a brief description of what the module is oriented at (be it a game, a puzzle, a task, etc.). This is followed by a detailed description of each HTTP interface, with descriptions of the possible parameters and return responses.

Sudoku
Takuzu
Set
Math
Schulte
Minesweeper
Wordsearch
Anagram

Sudoku

Sudoku is a popular number puzzle game. The essence of the game is to fill free cells with numbers from 1 to 9 so that in each row, each column and each small 3×3 square each digit occurs only once.

Generating random Sudoku

GET https://shadify.dev/api/sudoku/generator

Parameter	Description
`fill`	Optional A number from 0 to 100 that corresponds to the field fill level (as a percentage). The default value is 30.

Returned response:

{
    "grid": [
        [9, 8, 7, 3, 2, 1, 5, 6, 4],
        [6, 5, 4, 9, 8, 7, 2, 3, 1],
        [3, 2, 1, 6, 5, 4, 8, 9, 7],
        [7, 6, 5, 1, 9, 8, 3, 4, 2],
        [1, 9, 8, 4, 3, 2, 6, 7, 5],
        [4, 3, 2, 7, 6, 5, 9, 1, 8],
        [8, 7, 6, 2, 1, 9, 4, 5, 3],
        [5, 4, 3, 8, 7, 6, 1, 2, 9],
        [2, 1, 9, 5, 4, 3, 7, 8, 6]
    ],
    "task": [
        [0, 8, 7, 0, 0, 0, 0, 0, 4],
        [0, 0, 0, 9, 0, 0, 2, 0, 0],
        [0, 2, 1, 6, 5, 4, 0, 0, 7],
        [0, 0, 0, 1, 0, 8, 0, 4, 2],
        [0, 9, 8, 4, 3, 0, 0, 0, 0],
        [4, 0, 2, 0, 0, 0, 0, 0, 0],
        [8, 0, 6, 2, 0, 0, 0, 0, 0],
        [5, 0, 3, 0, 0, 6, 0, 2, 9],
        [0, 0, 0, 0, 4, 0, 0, 0, 0]
    ]
}

grid - fully solved Sudoku.
task - the task, which must be solved by filling in the zeros with the correct numbers.

Checking Sudoku

To check Sudoku you can use GET-request with required query-parameter

GET https://shadify.dev/api/sudoku/verifier

Parameter	Description
`task`	Required A string of the form `123-123-123`, which corresponds to the Sudoku field, where each line (row) is separated by a dash.

An example of a GET-request:

https://shadify.dev/api/sudoku/verifier?task=123564897-456897231-789231564-234675918-567918342-891342675-345786129-678129453-912453786

Also, for convenience, you can use POST-request with body in JSON format

POST https://shadify.dev/api/sudoku/verifier

Example body for a POST request:

{
    "task": [
        [9, 6, 3, 2, 8, 5, 7, 4, 1],
        [8, 5, 2, 1, 7, 4, 6, 3, 9],
        [1, 7, 4, 3, 9, 6, 8, 5, 2],
        [6, 3, 9, 8, 5, 2, 3, 1, 7],
        [5, 2, 8, 7, 4, 1, 3, 9, 6],
        [7, 4, 1, 9, 6, 3, 5, 2, 8],
        [4, 1, 7, 6, 3, 9, 2, 8, 5],
        [3, 9, 6, 5, 2, 8, 1, 7, 4],
        [2, 8, 5, 4, 1, 7, 9, 6, 3]
    ]
}

Returned response:

{
    "isError": true,
    "position": "row-4"
}

Takuzu

Takuzu (a.k.a. Binairo) is an entertaining puzzle game with simple rules. All you have to do is to fill a square field of a certain size with two digits (or colors) while following three simple rules:

Each column and each row must be unique
Each row and each column must have an equal number of tiles of each digit
no more than two tiles with the same digit in a row (110001 is wrong, 110010 is right).

For an example, you can see my app Binario

Generating Takuzu

GET https://shadify.dev/api/takuzu/generator

Parameter	Description
`size`	Optional An even number from 4 to 12, which specifies the size of the field. The default value is 8.
`fill`	Optional A number from 0 to 100 that corresponds to the field fill level (as a percentage). The default value is 33.

Returned response:

{
    "size": 8,
    "field": [
        ["1", "1", "0", "0", "1", "1", "0", "0"],
        ["1", "1", "0", "1", "0", "0", "1", "0"],
        ["0", "0", "1", "0", "1", "1", "0", "1"],
        ["0", "1", "1", "0", "0", "1", "1", "0"],
        ["1", "0", "0", "1", "1", "0", "0", "1"],
        ["0", "0", "1", "1", "0", "0", "1", "1"],
        ["0", "1", "1", "0", "1", "1", "0", "0"],
        ["1", "0", "0", "1", "0", "0", "1", "1"]
    ],
    "task": [
        ["1", "1", "0", "0", "x", "x", "0", "0"],
        ["x", "1", "0", "x", "0", "x", "x", "x"],
        ["x", "x", "1", "x", "x", "x", "x", "x"],
        ["x", "1", "1", "x", "x", "x", "1", "0"],
        ["x", "x", "x", "x", "x", "x", "x", "1"],
        ["0", "x", "x", "x", "x", "x", "x", "1"],
        ["x", "x", "x", "x", "x", "1", "0", "x"],
        ["x", "x", "x", "x", "x", "x", "1", "1"]
    ]
}

Checking Takuzu

To check Takuzu, you can use a GET-request with the required query parameter:

GET https://shadify.dev/api/takuzu/verifier

Parameter	Description
`task`	Required A string of the form `1010-1100-0011-0101`, which corresponds to the Takuzu field, where each line (row) is separated by a dash. It can only contain 0 and 1, the number of rows must be equal to the number of elements in each row.

An example of a GET-request:

https://shadify.dev/api/takuzu/verifier?task=1010-1100-0101-0101

Also, for convenience, you can use POST-request with body in JSON format

POST https://shadify.dev/api/takuzu/verifier

Example body for a POST-request:

{
    "task": [
        ["1", "0", "1", "0"],
        ["1", "1", "0", "0"],
        ["0", "0", "1", "1"],
        ["0", "1", "0", "1"]
    ]
}

Returned response:

{
    "isError": true,
    "message": "duplication",
    "position": ["row-3", "row-4"]
}

Set

Set (card game) – a fascinating card game. The game deck consists of 81 cards, each with one, two, or three of the same symbol (rhombus, oval, or wave) of the same color (red, green, or purple) and texture (shaded, shaded, or outline only). The essence of the game is to find a set - a set of three cards that meets certain conditions.

To understand the rules, read Wikipedia or watch this interesting video.

Get all cards

GET https://shadify.dev/api/set/start

Always returns the same array of 81 objects. Each object corresponds to one of the cards. An example of a card:

{
    "_id": 0,
    "number": 1,
    "shape": "diamond",
    "color": "red",
    "shading": "solid"
}

_id - a unique identifier for each card
number – number of figures: 1 | 2 | 3
shape – body shape: "diamond" | "squiggle" | "oval"
blee – figure color: "red" | "green" | "purple"
shading – figure shading: "solid" | "striped" | "open"

Generating a new game

GET https://shadify.dev/api/set/start

Parameter	Description
`possibleSets`	Optional A true/false string that enables/disables the search for possible sets in the current `layout`. The list of possible sets is not necessary for the game and acts only as a hint and evidence that sets exist in the current `layout`. Default value is true.

Returned response:

{
	"freeCards": [<69 cards>],
	"layout": [<12 cards>],
	"possibleSets": [[<3 cards>]],
	"wonCards": [],
	"state": "20-4-11-10-12-46-70-62-41-23-3-8"
}

freeCards – an array of objects corresponding to free maps that have not yet been used in the game.
layout – an array of objects corresponding to the maps that are available to play, i.e. to search for sets.
possibleSets – array containing arrays that include exactly 3 objects each. Each 3 object corresponds to a combination of three cards forming a set, which can be assembled from the cards available on the current layout.
wonCards – an array of objects corresponding to the won cards, which will no longer participate in the game.
state – A unique identifier for the current game state. It is needed to perform actions on deleting sets, adding additional cards or just to load the current game state. It has the following form 1-2-3@4-5-6, where the numbers to the left of the sign @ correspond to the unique identifiers of those cards that are in layout, and the numbers on the right are in wonCards.

Load state

GET https://shadify.dev/api/set/<:state>

Parameter	Description
`possibleSets`	Optional A true/false string that enables/disables the search for possible sets in the current `layout`. Default value is true.
`action`	Optional The add/remove string, which allows you to perform the appropriate action with the current game state. The add string adds 3 random cards from the current `freeCards` array to the current `layout` (available only if the `layout` size does not exceed 20 cards). The remove string removes the specified combination of three cards from the current `layout`. To do this you must use the `cards` parameter. There is no default value.
`cards`	Required for `action=remove` A string of the form 1-2-3, where each number corresponds to the unique identifier of one of the cards that make up the set. There is no default value.

Examples of requests with state loading:

https://shadify.dev/api/set/0-27-53-10-46-15-16-64-32-23-29-6?possibleSets=false

https://shadify.dev/api/set/41-47-7-53-13-46-25-36-72-60-15-80?action=add

https://shadify.dev/api/set/0-27-53-10-46-15-16-64-32-23-29-6?action=remove&cards=0-16-23

Math

A module for generating random mathematical expressions. Great for creating various simulators, where you'll have to wiggle your brain. You can see my application as an example.

Generating an expression with addition

GET https://shadify.dev/api/math/add

Generating an expression with subtraction

GET https://shadify.dev/api/math/sub

Generating an expression with multiplication

GET https://shadify.dev/api/math/mul

Generating an expression with division

GET https://shadify.dev/api/math/div

The following parameters are available for the above endpoints:

Parameter	Description
`minFisrt`, `maxFirst`	Optional Parameters that change the range of generated numbers only for the first number present in the expression. The default value for `minFirst` is 1, for `maxFirst` it is 99.
`minSecond`, `maxSecond`	Optional Parameters that change the range of generated numbers only for the second number present in the expression. These parameters do not affect expressions with division, because the second number is chosen randomly from the list of possible divisors of the first number. The default value for `minSecond` is 1, for `maxSecond` it is 99.
`negative`	Optional The number 0/1 which enables/disables the possibility of generating a result with a negative value for expressions with subtraction. Initially, when generating an expression with subtraction, the first number is always greater than the second number. To change this behavior, use this parameter. Default value is 0.

Returned response:

{
    "first": 17,
    "second": 56,
    "operation": "+",
    "expression": "17 + 56",
    "answer": 73
}

Generating a quadratic equation

Quadratic equation is an equation of the form ax2 + bx + c = 0, where the coefficients a, b and c are arbitrary numbers.

GET https://shadify.dev/api/math/quad

Parameter	Description
`minA`, `maxA`	Optional Minimum and maximum values of the coefficient A. The default value for `minA` is 1, for `maxA` it is 20.
`minB`, `maxB`	Optional Minimum and maximum values of the coefficient B. The default value for `minB` is 1, for `maxB` it is 40.
`minC`, `maxC`	Optional Minimum and maximum values of the coefficient C. The default value for `minC` is 1, for `maxC` it is 20.

Returned response:

{
    "equation": "1x^2 + 14x + 24 = 0",
    "a": 1,
    "b": 14,
    "c": 24,
    "discriminant": 100,
    "x1": "-12.000",
    "x2": "-2.000"
}

Schulte

Schulte Tables – tables with randomly arranged objects (usually numbers or letters) used to test and develop quickness of finding these objects in a certain order (usually in ascending order for numbers and alphabetical order for letters). Exercises with tables can improve peripheral visual perception, which will have a positive impact on the skill of speed reading.

Generating a Random Table

GET https://shadify.dev/api/schulte/generator

Parameter	Description
`size`	Optional The size of the generated table. The available range is from 1 to 15. The default value is 5.
`mode`	Optional The number / alphabet string, which defines the generated values for the table: numbers or letters. If alphabet is selected, the `size` parameter will always be 5. Default value is number.

Returned response:

{
    "grid": [
        [9, 18, 6, 1, 5],
        [11, 24, 25, 15, 19],
        [13, 7, 10, 21, 23],
        [20, 22, 12, 17, 16],
        [2, 8, 4, 14, 3]
    ]
}

Minesweeper

Minesweeper – a computer puzzle game in which the playing field is divided into adjacent cells, some of which are "mined"; the number of "mined" cells is known. The goal of the game is to open all the cells that do not contain mines. This game has become quite popular among Windows users, since it was pre-installed by default on older versions of that OS.

Generating a random field

GET https://shadify.dev/api/minesweeper/generator

Parameter	Description
`start`	Required A string of the form 1-2, which sets the starting position of the player. There will never be mines in and around this position. The first number is the X coordinate (from 1 to the value of the `widht` parameter), the second number is the Y coordinate (from 1 to the value of the `height` parameter) There is no default value.
`width`	Optional The number that sets the width of the generated field. The total number of cells in the field must not exceed 1000. The default value is 9.
`height`	Optional The number that sets the height of the generated field. The total number of cells in the field must not exceed 1000. The default value is 9.
`mines`	Optional The number that sets the number of mines on the field. The number of mines must not exceed 25% of the total number of cells on the field. The default value is 12.

Returned response:

{
    "start": "3-5",
    "width": 9,
    "height": 9,
    "board": [
        ["o", "o", "1", "x", "3", "x", "2", "x", "2"],
        ["1", "1", "1", "2", "x", "2", "2", "2", "x"],
        ["x", "1", "o", "1", "1", "1", "o", "1", "1"],
        ["1", "1", "o", "o", "o", "o", "o", "o", "o"],
        ["o", "o", "o", "1", "1", "1", "o", "o", "o"],
        ["2", "2", "1", "1", "x", "1", "o", "o", "o"],
        ["x", "x", "2", "2", "1", "1", "o", "1", "1"],
        ["x", "4", "x", "1", "o", "o", "o", "1", "x"],
        ["1", "2", "1", "1", "o", "o", "o", "1", "1"]
    ],
    "mines": 12
}

Wordsearch

Word search is a puzzle consisting of letters of words placed in a square or rectangular grid. The aim of the puzzle is to find and mark all the words hidden in the grid. The words can be placed horizontally, vertically or diagonally.

Generating a random grid

GET https://shadify.dev/api/wordsearch/generator

Parameter	Description
`width`	Optional A number from 5 to 20 that specifies the width of the grid. The total number of cells in the field must not exceed 256. The default value is 9.
`height`	Optional A number from 5 to 20 that specifies the width of the grid. The total number of cells in the field must not exceed 256. The default value is 9.

Returned response:

{
    "width": 9,
    "height": 9,
    "wordsCount": 10,
    "grid": [
        ["e", "n", "r", "w", "r", "o", "l", "o", "c"],
        ["t", "o", "o", "o", "a", "l", "n", "b", "p"],
        ["e", "o", "o", "l", "z", "a", "w", "r", "a"],
        ["l", "n", "s", "p", "r", "e", "o", "u", "n"],
        ["h", "r", "t", "w", "e", "m", "t", "g", "t"],
        ["t", "e", "e", "o", "l", "t", "n", "b", "s"],
        ["a", "t", "r", "n", "l", "a", "w", "y", "t"],
        ["v", "f", "s", "s", "e", "o", "o", "f", "j"],
        ["i", "a", "b", "d", "t", "z", "d", "s", "n"]
    ],
    "words": [
        { "word": "color", "position": { "start": [9, 1], "end": [5, 1] } },
        { "word": "downtown", "position": { "start": [7, 9], "end": [7, 2] } },
        { "word": "teller", "position": { "start": [5, 9], "end": [5, 4] } },
        { "word": "pants", "position": { "start": [9, 2], "end": [9, 6] } },
        { "word": "athlete", "position": { "start": [1, 7], "end": [1, 1] } },
        { "word": "afternoon", "position": { "start": [2, 9], "end": [2, 1] } },
        { "word": "snowplow", "position": { "start": [4, 8], "end": [4, 1] } },
        { "word": "rooster", "position": { "start": [3, 1], "end": [3, 7] } },
        { "word": "rugby", "position": { "start": [8, 3], "end": [8, 7] } },
        { "word": "oatmeal", "position": { "start": [6, 8], "end": [6, 2] } }
    ]
}

Anagram

Anagrams is a whole type of puzzles associated with composing all possible words from a given set of letters. This module implements the simplest variation of anagrams: a random word is given, the letters of which should be used to compose as many other words as possible.

Only English nouns are used for composition, a list of which can be found in this repository at the path ./data/nouts.txt.

GET https://shadify.dev/api/anagram/generator

Returned response:

{
    "Task":"possibility",
    "Words":[
        "bit","bolt","boy","lip","list","loss","oil",
        "pilot","plot","toy","pot","slip","soil","soy",
        "spot","spy","stop","tip","top"
    ]
}

Task - a word from which you need to make other words.
Words - an array of all possible words that are compiled from Task.

Starting a local server

Clone this repository onto your computer:

git clone https://github.com/cheatsnake/shadify.git

From the root directory of the project, run the following command:

go run cmd/server/main.go

Made with ♥

LICENSE 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Shadify

Quick overview

Documentation

Sudoku

Takuzu

Set

Math

Schulte

Minesweeper

Wordsearch

Anagram

Starting a local server

Files

README.md

Latest commit

History

README.md

File metadata and controls

Shadify

Quick overview

Documentation

Sudoku

Takuzu

Set

Math

Schulte

Minesweeper

Wordsearch

Anagram

Starting a local server