DISPLAY-1030: Initial cleanup

Author: rimi-itk

.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "default": true,
+  "MD013": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  "no-duplicate-heading": {
+    "siblings_only": true
+  }
+}

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+- [#165](https://github.com/os2display/display-api-service/pull/165)
+  Symfony 6.3
 - [#161](https://github.com/os2display/display-api-service/pull/161)
   Fixed non-entity related psalm errors.
 
@@ -17,10 +19,12 @@ All notable changes to this project will be documented in this file.
   Added thumbnails for image resources
 
 ## [1.3.2] - 2023-07-11
+
 - [#157](https://github.com/os2display/display-api-service/pull/157)
   Fix question input on create user command
 
 ## [1.3.1] - 2023-07-11
+
 - [#156](https://github.com/os2display/display-api-service/pull/156)
   Fix permissions in create release github action
 
@@ -69,10 +73,9 @@ Gif mime type possible.
 - [#138](https://github.com/os2display/display-api-service/pull/138)
   Fixed Tenant and command to allow for empty fallbackImageUrl.
 - [#139](https://github.com/os2display/display-api-service/pull/139)
-  Changed from service decoration to event listeners to re-enable setting `tenants` on the response from `/v1/authentication/token`.  
-  Ensure same response data from both `/v1/authentication/token` and `/v1/authentication/token/refresh`endpoints.  
+  Changed from service decoration to event listeners to re-enable setting `tenants` on the response from `/v1/authentication/token`.
+  Ensure same response data from both `/v1/authentication/token` and `/v1/authentication/token/refresh`endpoints.
   Added `user` and `tenants` to JWT payload.
-  
 
 ## [1.2.4] - 2023-03-07
 

README.md

@@ -27,7 +27,8 @@ A `docker-compose.yml` file with a PHP 8.0 image is included in this project.
 To install the dependencies you can run
 
 ```shell
-docker compose up -d
+docker compose pull
+docker compose up --detach
 docker compose exec phpfpm composer install
 
 # Run migrations
@@ -123,8 +124,8 @@ the coding standard for the project.
 * Markdown files (markdownlint standard rules)
 
     ```shell
-    docker run -v ${PWD}:/app itkdev/yarn:latest install
-    docker run -v ${PWD}:/app itkdev/yarn:latest check-coding-standards
+    docker compose run --rm node yarn install
+    docker compose run --rm node yarn coding-standards-check
     ```
 
 ### Apply Coding Standards
@@ -140,8 +141,8 @@ To attempt to automatically fix coding style issues
 * Markdown files (markdownlint standard rules)
 
     ```shell
-    docker run -v ${PWD}:/app itkdev/yarn:latest install
-    docker run -v ${PWD}:/app itkdev/yarn:latest apply-coding-standards
+    docker compose run --rm node yarn install
+    docker compose run --rm node yarn coding-standards-apply
     ```
 
 ## CI

docker-compose.yml

@@ -1,4 +1,4 @@
-# itk-version: 3.0.0
+# itk-version: 3.1.0
 version: "3"
 
 networks:
@@ -32,7 +32,8 @@ services:
       - PHP_XDEBUG_MODE=${PHP_XDEBUG_MODE:-off}
       - PHP_MAX_EXECUTION_TIME=30
       - PHP_MEMORY_LIMIT=256M
-      # - PHP_MAIL=1 # Uncomment to enable mailhog.
+      # Depending on the setup you may have to remove --read-envelope-from from msmtp (cf. https://marlam.de/msmtp/msmtp.html) or use SMTP to send mail
+      - PHP_SENDMAIL_PATH=/usr/bin/msmtp --host=mail --port=1025 --read-recipients --read-envelope-from
       - DOCKER_HOST_DOMAIN=${COMPOSE_DOMAIN}
       - COMPOSER_VERSION=2
       - PHP_IDE_CONFIG=serverName=localhost
@@ -61,8 +62,8 @@ services:
       - "traefik.http.routers.${COMPOSE_PROJECT_NAME}.middlewares=redirect-to-https"
       - "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
 
-  mailhog:
-    image: itkdev/mailhog
+  mail:
+    image: axllent/mailpit
     networks:
       - app
       - frontend
@@ -72,12 +73,20 @@ services:
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
-      - "traefik.http.routers.${COMPOSE_PROJECT_NAME}Mailhog.rule=Host(`mailhog-${COMPOSE_DOMAIN}`)"
-      - "traefik.http.services.${COMPOSE_PROJECT_NAME}Mailhog.loadbalancer.server.port=8025"
+      - "traefik.http.routers.${COMPOSE_PROJECT_NAME}mail.rule=Host(`mail-${COMPOSE_DOMAIN}`)"
+      - "traefik.http.services.${COMPOSE_PROJECT_NAME}mail.loadbalancer.server.port=8025"
 
   redis:
     image: 'redis:6'
     networks:
       - app
     ports:
       - '6379'
+
+  node:
+    image: node:20
+    working_dir: /app
+    volumes:
+      - .:/app
+    profiles:
+      - develop

infrastructure/itkdev/Readme.md

@@ -1,3 +1,3 @@
 # ITK-development image build
 
-This folder contains the infrastructure files for building the `itkdev/*` images 
+This folder contains the infrastructure files for building the `itkdev/*` images

infrastructure/os2display/Readme.md

@@ -1,3 +1,3 @@
 # OS2display image build
 
-This folder contains the infrastructure files for building the `os2display/*` images 
+This folder contains the infrastructure files for building the `os2display/*` images

package.json

@@ -5,9 +5,9 @@
     "markdownlint-cli": "^0.27.1"
   },
   "scripts": {
-    "check-coding-standards/markdownlint": "markdownlint README.md docs/**/*.md",
-    "check-coding-standards": "yarn check-coding-standards/markdownlint",
-    "apply-coding-standards/markdownlint": "markdownlint --fix README.md docs/**/*.md",
-    "apply-coding-standards": "yarn apply-coding-standards/markdownlint"
+    "coding-standards-check/markdownlint": "markdownlint --ignore vendor --ignore node_modules '**/*.md'",
+    "coding-standards-check": "yarn coding-standards-check/markdownlint",
+    "coding-standards-apply/markdownlint": "markdownlint --ignore vendor --ignore node_modules '**/*.md' --fix",
+    "coding-standards-apply": "yarn coding-standards-apply/markdownlint"
   }
 }

tests/config/jwt/Readme.md

@@ -1,3 +1,5 @@
-CI server and test keys. Do not use in production.
+# CI server and test keys
 
-@see https://github.com/lexik/LexikJWTAuthenticationBundle/blob/2.x/Resources/doc/3-functional-testing.md
+Do not use in production.
+
+@see <https://github.com/lexik/LexikJWTAuthenticationBundle/blob/2.x/Resources/doc/3-functional-testing.md>