Sudoku Collective is an open source Web API that is used to learn frontend client side technologies such as React or Vue.js. With this API developers will create an app that allows players to play sudoku puzzles and compare their performance against other players. The benefit of using this tool is that once the developer creates their first app they will obtain an understanding of how the API works and will then be better able to compare and understand various frontend technologies like React or Vue.js. The API is fully documented so developers can integrate their client apps with the API. The goals are to learn, develop and have fun!
For the Redis Cache Server on Windows 10 it is recommended you use Windows Subsystem for Linux in order to install and run Redis through Ubuntu on Windows Subsystem for Linux. The instructions for downloading from the official Ubuntu PPA are contained in the above Redis link. For Windows 11 you can install and configure a local Redis Server using Docker.
In the API project you will find a dummysettings.json file that is a stand in for the appsettings.json file that configures the project. Additionally you will find dummy files for the appsettings.Development.json, appsettings.Staging.json, and appsettings.Production.json files and appsettings.Test.json in the Test project. Simply rename the dummysettings.json to appsettings.json and place your value where it states [Your value here]. Following the same process for the respective appsetting environment files.
There is also a dummy file for docker-compose, docker-compose-dummy.yml. Simply rename docker-compose-dummy.yml to docker-compose.yml and place your values for POSTGRES_USER and POSTGRES_PASSWORD where it states [Your value here].
For the License field in DefaultAdminApp, DefaultClientApp, and DefaultSandboxApp you can enter a hexadecimal value, random values can be generated here, braces shouldn't be included and you should use hyphens.
Once the above is done run the following command to instantiate the database:
dotnet ef database update
Once done the project will be ready to run.
There is also a related Vue.js administrative app which allows you to manage app licenses, Sudoku Collective Admin Console. The installation instructions for that project can be reviewed in its README file.