Db backup

.github/workflows/docker.yml

@@ -22,28 +22,28 @@ jobs:
         run: npm ci
 
       - name: Check syntax (prettier)
-        run: npx prettier --check .
+        run: npm run prettier-check
 
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         if: ${{ github.event_name == 'push' }}
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name == 'push' }}
           build-args: |
-            COMMIT_SHA=${{ github.sha }}
+            TMT_COMMIT_SHA=${{ github.sha }}
           tags: |
             jensforstmann/tmt2:${{ github.sha }}
             jensforstmann/tmt2:latest

.github/workflows/release.yml

@@ -12,24 +12,27 @@ jobs:
         uses: olegtarasov/get-tag@v2.1
         id: tagName
         with:
-          tagRegex: "(?<major>.*)\\.(?<minor>.*)"
+          tagRegex: "v(?<major>.*)\\.(?<minor>.*)\\.(?<patch>.*)"
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
       - name: Build and push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           platforms: linux/amd64,linux/arm64
           push: true
           build-args: |
-            COMMIT_SHA=${{ github.sha }}
+            TMT_COMMIT_SHA=${{ github.sha }}
+            TMT_VERSION=${{ steps.tagName.outputs.major }}.${{ steps.tagName.outputs.minor }}.${{ steps.tagName.outputs.patch }}
           tags: |
+            jensforstmann/tmt2:v${{ steps.tagName.outputs.major }}
             jensforstmann/tmt2:${{ steps.tagName.outputs.major }}
             jensforstmann/tmt2:${{ steps.tagName.outputs.major }}.${{ steps.tagName.outputs.minor }}
+            jensforstmann/tmt2:${{ steps.tagName.outputs.major }}.${{ steps.tagName.outputs.minor }}.${{ steps.tagName.outputs.patch }}

.prettierrc.yml

@@ -6,7 +6,7 @@ singleQuote: true
 printWidth: 100
 useTabs: true
 overrides:
-  - files: '**/*.yml'
+  - files: ['**/*.yaml', '**/*.yml']
     options:
       tabWidth: 2
       useTabs: false

Dockerfile

@@ -25,13 +25,19 @@ COPY frontend/vite.config.mts .
 RUN npm run build
 
 FROM node:20
+ENV TINI_VERSION=v0.19.0
+ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini
+RUN chmod +x /tini
 COPY --from=backend_build_image /app/backend/package.json /app/backend/swagger.json /app/backend/
 COPY --from=backend_build_image /app/backend/dist /app/backend/dist
 COPY --from=backend_build_image /app/backend/node_modules /app/backend/node_modules
 COPY --from=frontend_build_image /app/frontend/dist /app/frontend/dist
 VOLUME /app/backend/storage
 EXPOSE 8080
-ARG COMMIT_SHA
-ENV COMMIT_SHA=${COMMIT_SHA}
+ARG TMT_COMMIT_SHA
+ENV TMT_COMMIT_SHA=${TMT_COMMIT_SHA}
+ARG TMT_VERSION
+ENV TMT_VERSION=${TMT_VERSION}
+RUN date -u +"%Y-%m-%dT%H:%M:%SZ" > /app/.TMT_IMAGE_BUILD_TIMESTAMP
 WORKDIR /app/backend
-CMD ["npm", "start"]
+CMD ["/tini", "node", "./dist/backend/src/index.js"]

README.md

@@ -1,7 +1,10 @@
 # TMT2 - Tournament Match Tracker 2
 
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/JensForstmann/tmt2/docker.yml?label=docker%20build)](https://github.com/JensForstmann/tmt2/actions/workflows/docker.yml)
 [![Docker Pulls](https://img.shields.io/docker/pulls/jensforstmann/tmt2)](https://hub.docker.com/r/jensforstmann/tmt2)
-[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest)](https://hub.docker.com/r/jensforstmann/tmt2)
+[![Docker Image Size](https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest?label=docker%20image%20size)](https://hub.docker.com/r/jensforstmann/tmt2)
+
+
 
 TMT is a tool that tracks/watches/observes a Counter-Strike 2 match.
 
@@ -53,19 +56,24 @@ Table of Contents:
     - [match specific access tokens](#match-specific-access-tokens)
 - [Development](#development)
   - [Docker](#docker)
-  - [NodeJS](#nodejs)
+  - [Install dependencies and run application in development mode](#install-dependencies-and-run-application-in-development-mode)
+  - [Build docker image](#build-docker-image)
+
+
 
 ## Getting Started
 
 TMT2 is available on docker hub: https://hub.docker.com/r/jensforstmann/tmt2
 
-Run it with:
+You can either use a [docker compose file (compose.yaml)](compose.yaml) or run it directly with `docker run`:
 
 ```sh
 docker run --name tmt2 -d -p 8080:8080 jensforstmann/tmt2
 ```
 
-Data will be written within the container to `/app/backend/storage`. To keep the files with different containers you can either specify a docker volume or a path on the local system:
+Data will be written within the container to `/app/backend/storage`.
+To keep the files with different containers
+you can either specify a docker volume or a path on the local system:
 
 ```sh
 # docker volume
@@ -77,9 +85,12 @@ docker run --name tmt2 -d -p 8080:8080 -v /home/tmt2/storage:/app/backend/storag
 
 The matches which are neither finished nor stopped will be loaded on application start.
 
+
+
 ### Create you first Match
 
-After running the container you can open the web frontend: http://localhost:8080 (or at whatever ip/server your docker container runs on.)
+After running the container you can open the web frontend: http://localhost:8080
+(or at whatever ip/server your docker container runs on.)
 
 
 
@@ -88,14 +99,20 @@ _Example screenshot: Create a new match from the web frontend (both dark and lig
 
 
 
-Even without an admin token you can create and manage matches (but only your own ones). If you want to know your admin token (a random one is generated at startup) either take a look at the `access_tokens.json` file or take a look at the first lines of the log output (`docker logs tmt2`).
+Even without an admin token you can create and manage matches (but only your own ones).
+If you want to know your admin token (a random one is generated at startup)
+either take a look at the `access_tokens.json` file
+or take a look at the first lines of the log output (`docker logs tmt2`).
+
 
 
 ### Ingame Chat Commands
 
 While TMT watches a match the player ingame can use chat commands to communicate with TMT:
 
-- `.team a` or `.team b` - you need to choose a team before you can execute any other commands, check the response in the chat to be sure you've joined the right one, also check the scoreboard (team names are visible there) if you're on the right side (CT/T)
+- `.team a` or `.team b` - you need to choose a team before you can execute any other commands,
+  check the response in the chat to be sure you've joined the right one,
+  also check the scoreboard (team names are visible there) if you're on the right side (CT/T)
 - during the map election process:
   - `.ban` - ban a map from the map pool
   - `.pick` - pick a map to be played
@@ -113,7 +130,8 @@ While TMT watches a match the player ingame can use chat commands to communicate
 - during the match
   - `.pause` - pause the match at the next freezetime (alias `.tech`)
   - `.unpause` - set your team as ready (alias `.ready` & `.rdy`)
-  - `.tac` - like pause, but uses up a tactical timeout for that team (same as calling an ingame vote for a tactical timeout)
+  - `.tac` - like pause, but uses up a tactical timeout for that team
+    (same as calling an ingame vote for a tactical timeout)
 
 
 
@@ -137,12 +155,16 @@ TMT_SAY_PREFIX="[TMT] "
 ```
 
 
+
 ## API
 
-See [`backend/swagger.json`](backend/swagger.json). You might want to copy its content and paste it into https://editor.swagger.io/.
+See [`backend/swagger.json`](backend/swagger.json).
+You might want to copy its content and paste it into https://editor.swagger.io/.
 
 See also the [`examples`](examples) folder.
 
+
+
 ## Security / Authentication
 
 There are two types of authentication:
@@ -158,6 +180,8 @@ Both are used in client requests in the Authorization header with a "Bearer "-pr
     Authorization: Bearer 2Mgog6ATqAs495NtUQUsph
     ...
 
+
+
 ### global access tokens
 
 Global access tokens are persisted in the storage folder in the file `access_tokens.json`.
@@ -182,6 +206,8 @@ Example:
 
 If the file does not exist at startup a new one with a single auto generated global access token will be created.
 
+
+
 ### match specific access tokens
 
 Every match will have a `tmtSecret` property. This can be used in the same way as a global access token.
@@ -199,46 +225,76 @@ After starting the dev processes you can reach the backend & frontend at:
 - Backend: http://localhost:8080
 - Frontend: http://localhost:5173
 
-## Docker
 
-Docker is recommended as it's easy to use and doesn't require any other software to be installed (if docker is already set up).
 
-> Note for windows user: It's recommended to have docker installed **directly within** WSL (not using Windows Docker from WSL) or to run a Linux VM.
-
-Init the dev environment:
+## Docker
 
-    ./dev-container-init.sh
+Docker is recommended as it's easy to use and doesn't require any other software to be installed
+(if docker is already set up).
 
-Start a docker container with port forwarding and hot reloading:
+> *Note for windows user:*
+> 
+> For better performance it's recommended to have docker (and this repo)
+> installed **directly within** WSL (not using Windows Docker from WSL) or to run a Linux VM.
 
-    ./dev-container-start.sh
+```shell
+# Linux:
+./dev-container.sh
+```
 
+```powershell
+# Windows
+.\dev-container.ps1
+```
 
 
-## NodeJS
 
-If you don't want to use docker or want to use NodeJS directly, you can do the following to setup a dev environment:
+## Install dependencies and run application in development mode
 
 Install dependencies:
 
-    npm install
-    cd backend
-    npm install
-    cd ../frontend
-    npm install
+```sh
+npm install
+cd backend
+npm install
+cd ../frontend
+npm install
+```
 
 Run backend with hot reloading:
 
-    cd backend
-    npm run dev
+```sh
+cd backend
+npm run dev
+```
 
 Run frontend with hot reloading:
 
-    cd frontend
-    npm run dev
+```sh
+cd frontend
+npm run dev
+```
+
+Run both backend and frontend with hot reloading:
+
+```sh
+npm run dev
+```
+
+
+
+## Build docker image
+
+To build a docker image locally:
+
+```sh
+docker build -t tmt2 .
+```
 
 
 
 ---
 
+
+
 > This project is a complete rewrite of the former [TMT](https://github.com/JensForstmann/CSGO-PHP-TournamentMatchTracker).