Shadify

Shadify is a powerful REST API service provides a collection of different puzzle types, like crosswords, Sudoku, word search and so on. The API allows users to generate data for puzzles, check the correctness of solutions, and configure various parameters to change the difficulty of the puzzles.

📃 Documentation

All documentation is available on the official website.

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
• Countries
• Camp
• Kuromasu
• Memory

Translations: Russian

🚀 Server startup

1. Clone this repository onto your computer:

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

2. Inside the project, run this command to install the necessary packages:

go mod download

Make sure you have already installed Go on your computer.

3. Start the server by running the last command:

go run cmd/server/main.go

The server will start at the address http://localhost:5000

For easy testing, use a ready-made collection for Insomnia. Open Settings > Data > Import Data > From URL and paste link to the insomnia.shadify.json file. Enjoy!

🐳 Docker container startup

• Running a Docker container for development (after any file changes, server will be restarts):

docker compose up

• Running a Docker container for production:

docker build -t shadify . --target prod

docker run --rm -p 5000:5000 --name shadify shadify

Made with ♥

LICENSE 2022-2023