Merge pull request #142 from nohn/chore/improve-build-process

allow building self contained using Docker instead of github actions

Author: nohn

.dockerignore

@@ -0,0 +1,7 @@
+vendor/
+.git/
+.idea/
+log/*.log
+tmp/*
+!tmp/.gitkeep
+!log/.gitkeep

.github/workflows/ci.yml

@@ -11,21 +11,6 @@ jobs:
     steps:
       - name: Pull Code
         uses: actions/checkout@v3
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.3
-          extensions: imagick
-          coverage: xdebug
-          tools: phpstan
-      - name: Install dependencies
-        run: sudo apt install tesseract-ocr
-      - name: Install composer dependencies
-        run: composer update --no-ansi --no-interaction --no-progress
-      - name: Run PHPStan
-        run: phpstan analyse src
-      - name: Run unit tests
-        run: vendor/bin/phpunit tests
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx

Dockerfile

@@ -1,12 +1,41 @@
-FROM php:8.3.12-cli
+FROM php:8.3.12-cli AS base
 RUN apt-get update \
-    && apt-get install -y libmagickwand-dev tesseract-ocr \
+    && apt-get install -y libmagickwand-dev tesseract-ocr unzip \
     && pecl install imagick \
     && docker-php-ext-enable imagick
-COPY ./classes    /usr/src/watermeter/classes
-COPY ./log        /usr/src/watermeter/log
-COPY ./public     /usr/src/watermeter/public
-COPY ./src        /usr/src/watermeter/src
-COPY ./vendor     /usr/src/watermeter/vendor
+
+FROM base AS build
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+WORKDIR /usr/src/watermeter
+COPY composer.json ./
+RUN composer install --no-ansi --no-interaction --no-progress
+COPY . .
+
+# Run Static Analysis
+RUN vendor/bin/phpstan analyse src classes
+# Run Unit Tests
+RUN vendor/bin/phpunit tests
+
+FROM base AS final
+WORKDIR /usr/src/watermeter
+
+# Ensure that the build stage (tests and PHPStan) has been executed successfully
+# by copying a file from it. This creates a dependency so Docker won't skip it.
+COPY --from=build /usr/src/watermeter/composer.json /usr/src/watermeter/composer.json
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+COPY composer.json ./
+
+# Do not install dev dependencies on final build
+RUN composer install --no-dev --optimize-autoloader --no-ansi --no-interaction --no-progress
+
+# Create necessary directories and set permissions
+RUN mkdir -p log/debug log/error tmp \
+    && chmod -R 777 log tmp
+
+COPY classes/ ./classes/
+COPY public/ ./public/
+COPY src/ ./src/
+COPY LICENSE README.md ./
+
 WORKDIR /usr/src/watermeter/public
 CMD [ "php", "-S", "0.0.0.0:3000" ]

README.md

@@ -12,7 +12,7 @@ This is only a quick introduction to setting up and configuring watermeter. A mo
 
 ### Installation
 
-#### Using Docker Compose (recommended)
+#### Using Docker Compose and Docker Hub (recommended)
 
 ```yaml
 version: "3.5"
@@ -27,6 +27,14 @@ services:
       - "3000:3000"
 ```
 
+#### Building locally
+
+If you want to build the Docker image locally, you can use the following command:
+
+```bash
+docker build . -t nohn/watermeter
+```
+
 ### Configuration
 
 You can access the configuration tool http://watermeter:3000/configure.php. The interface should be self explanatory. Source Image can be either in local filesystem or any HTTP(S) resource.
@@ -58,4 +66,4 @@ Consider a [gift](https://www.amazon.de/hz/wishlist/ls/3HYH6NR8ZI0WI?ref_=wl_sha
 
 ## License
 
-analogmeterreader is released under the [GNU Affero General Public License](LICENSE).
+watermeter is released under the [GNU Affero General Public License](LICENSE).

composer.json

@@ -19,7 +19,8 @@
     "ext-json": ">=8.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^11.3"
+    "phpunit/phpunit": "^11.3",
+    "phpstan/phpstan": "^2.1"
   },
   "support": {
     "issues": "https://github.com/nohn/watermeter/issues"