Update typescript-eslint monorepo to v5 (major)

.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+build
+.dockerignore
+Dockerfile
+Dockerfile.prod

.gitignore

@@ -7,3 +7,5 @@
 .DS_Store
 
 /src/config/local.json
+/coverage/*
+.vscode

Dockerfile

@@ -0,0 +1,15 @@
+# Tutorial https://mherman.org/blog/dockerizing-a-react-app/
+FROM node:14
+
+WORKDIR /src
+
+ENV PATH /node_modules/.bin:$PATH
+
+COPY package.json ./
+COPY package-lock.json ./
+RUN npm install --silent
+
+COPY . ./
+
+# start app
+CMD ["npm", "run", "dev"]

README.md

@@ -10,30 +10,31 @@ We hope to release a publicly playable version in April. You can find the latest
 
 Currently, to play, you will need to run your own back-end nodes. We are working on a Docker container to make this easy, which is expected to ship in April. [Here](https://github.com/NOCTLJRNE/CHIPS-tuto/blob/master/README.md) you can find the old, complicated way of setting up the back-end nodes.
 
+## Start the game
+
+- `npm install && npm start`
+
 ## Development
 
-- Run `npm install` and `npm start` in the root folder This will fire up a web server and you can try the app via http://localhost:1234
+Server runs at port 1234 - http://localhost:1234
 
-- Run `npm run electron-dev` to start the Electron app in development.
+- `npm install && npm run dev` - start with `NODE_ENV=development`
 
-Run `npm electron-pack` to package the app with electron-builder for MacOS, Windows and Linux.
+- `npm run electron-dev` to start the Electron app in development.
 
-### Pre-push GitHook 
+- `npm electron-pack` to package the app with electron-builder for MacOS, Windows and Linux.
 
-In order not to fail Gitub CI all the time, set up a local git hook to check lint and run tests before a push to the repo.
+### Debugging
 
- [Pre push Github docs](https://www.git-scm.com/docs/githooks#_pre_push)
+browser plugin [React Context Dev Tools](https://github.com/deeppatel234/react-context-devtool)
 
+### Sockets
 
-`nano ./.git/hooks/pre-push`
+When the player enters the game he opens two socket connections:
 
-```
-set -e
-node_modules/eslint/bin/eslint.js './src/' --ext .js,.ts,.tsx
-npm run test
-```
+ - for writing `playerWrite`
 
-`sudo chmod +x ./.git/hooks/pre-push`
+ - for reading `playerRead`
 
 ### State Management
 
@@ -42,10 +43,6 @@ https://blog.logrocket.com/use-hooks-and-context-not-react-and-redux/
 Good video explaining redux vs context state management approach
 https://www.youtube.com/watch?time_continue=134&v=eBYJ7O482Dc&feature=emb_title
 
-### Developer Mode
-
-You can activate developer mode and skip the startup modal by adjusting the `src/config/local.json`.
-
 ### Environment variables in scripts
 
 REDUCER - adds extra logging from reducer to the console output.

docs/sitout.md

@@ -0,0 +1,29 @@
+# Sitout
+
+# Implementation
+
+<img src="assets/Sitout_Flow.png" width="800">
+
+The dealer should be allowed to set the table number.
+E.g they set 6/9 (max of 9 players, minimum of 6). 
+If there are 5 players, the hand doesn't start. If there are 6,7,8,9 players, the hand starts. 
+This # of players does not include players that are 'sitting out'.
+
+A player should only be able to sit out for a set amount of hands/time. People should have the option to sit out for comfort breaks. But people shouldn't be allowed to sit out for prolonged periods of time.
+
+
+## Alpha (Current implementation, showcase)
+
+The hand is in progress. Player 1 checks "Sitout the next hand". After the hand finishes, Player1 sits out. Currently the seat is not reserved by the player 1, that will be included in the beta version. Technically player 1 is out of the game, but their node is not disconnected, it is waiting for them to decide to join again. Their seat is available for other player to join. Player 3 joins the game, takes the vacant seat, the game starts again, since the condition of minimum of 2 players has been met.
+
+If the player 2 wants to join the game again he needs to wait for player 3 to sitout.
+
+This current implementation is more of a showcase that it is implementable.
+
+
+## Beta
+
+Player's seat is reserved by the player when he sits out. The hand starts if the minimum number of players not including the ones sitting out is met. Player can join back in the game when he decides to stop sitting out.
+
+
+

docs/testcases/Sitout.md

@@ -0,0 +1,13 @@
+# Sitout testcase
+
+1. Run notaries, dealer, 2 players. Make sure the dealer is configured for 2 players and the players have your notaries in their configuration.
+
+2. Run GUI x 3 times
+
+3. Enter the game as a dealer -> Private -> dealer.
+
+4. Enter the game as each player -> Private -> player.
+
+5. The game starts after each player takes a seat. Dealer does not have to do anything.
+
+6. Make a bet, then check "sitout at the next hand"

jest.config.js

@@ -82,7 +82,7 @@ module.exports = {
   // A map from regular expressions to module names that allow to stub out resources with a single module
   moduleNameMapper: {
     "\\.(css|less|sass|scss)$": "<rootDir>/__mocks__/styleMock.js",
-    "\\.(gif|ttf|eot|svg|mp3)$": "<rootDir>/__mocks__/fileMock.js"
+    "\\.(gif|ttf|eot|svg|jpg|png|mp3)$": "<rootDir>/__mocks__/fileMock.js"
   },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader