README.md

Mastermind-laravel

Architecture

When a user starts the game, the user gets redirected to /game/ Everyone has read access to this page. But only the game creator can write to it.

All games are stored in a database. The games table looks like this:

game
---
id INDEX int
code TEXT
code_length int
score NULL int
turn int
selected_emoji int
won bool
lost bool
# Static virtual field in the model definition
emoji_map VIRTUAL

row
---
id INDEX AUTOINCREMENT int
# A game has many rows
game_id INDEX int FK >- game.id

slot
---
id INDEX AUTOINCREMENT int
# A row has many slots
row_id INDEX int FK >- row.id
# Value of 0-8 which can be looked up in
# the game->emoji_map
value int
# A hint is either 0, 1 or 2. Where 0 is no
# hint, 1 is exact and 2 is partial
hint int

Table for users:

CREATE TABLE users (
  id number PRIMARY KEY,
  name TEXT,
  email TEXT,
  password TEXT,
  created_at DATETIME DEFAULT CURRENT_TIMESTAMP,
  updated_at DATETIME DEFAULT CURRENT_TIMESTAMP,
);

API

• GET /api/games
  • Returns a list of all games
• POST /api/games
  • Create a new game
  • Returns the game in JSON with auth_token
• GET /api/games/<id>
  • Returns the game in JSON withouth auth_token
• PUT/PATCH /api/games/<id> (Authorized endpoint)
  • Update the game
  • Only valid if selected_emoji is correct
• PUT/PATCH /api/slots/<id> (Authorized endpoint)
  • Update the slot
  • Only valid if value is correct

Authorization

• Authorization is done via the Authorization header.
• The header must contain the auth_token of the game.