release: dev → main (add frontend build system) (#110)

    New Features
        Modern frontend build and bundling setup with Node/Yarn support and asset compilation
        CORS support enabled for API compatibility

    Chores
        Updated build tooling and runtime dependencies; added image processing support in the runtime environment
        Docker and compose improvements for build steps and persistent logs/cache; adjusted ignore rules

    Tests
        Added test bootstrap and improved server-error assertion in endpoint tests

    Documentation
        Added instructions to build and publish frontend assets

---------

Co-authored-by: Tatevik <tatevikg1@gmail.com>

Author: TatevikGr

.dockerignore

@@ -6,14 +6,15 @@
 .vscode
 node_modules
 npm-debug.log
-yarn.lock
 composer.phar
 var/cache
 var/logs
+var/log
 var/sessions
 .env
 Dockerfile*
 docker-compose*.yml
 **/.DS_Store
 **/Thumbs.db
 vendor/
+public/build

.gitignore

@@ -12,6 +12,7 @@
 /public/
 /var/
 /vendor/
+/node_modules/
 .DS_Store
 .vagrant
 .phpunit.result.cache

Dockerfile

@@ -11,12 +11,18 @@ RUN apt-get update \
     && apt-get install -y --no-install-recommends \
         git unzip libzip-dev libicu-dev libpng-dev libonig-dev libxml2-dev \
         libc-client2007e-dev libkrb5-dev libssl-dev libpq-dev \
+        libfreetype6-dev libjpeg62-turbo-dev \
     && docker-php-ext-configure intl \
     && docker-php-ext-configure imap --with-kerberos --with-imap-ssl \
+    && docker-php-ext-configure gd --with-freetype --with-jpeg \
     && docker-php-ext-install -j"$(nproc)" \
-        pdo pdo_mysql pdo_pgsql zip intl imap \
+        pdo pdo_mysql pdo_pgsql zip intl imap gd \
     && rm -rf /var/lib/apt/lists/*
 
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
+    && apt install -y nodejs \
+    && npm install -g yarn
+
 # Enable Apache modules and set DocumentRoot to /public
 RUN a2enmod rewrite headers \
     && sed -ri 's!/var/www/html!/var/www/html/public!g' /etc/apache2/sites-available/000-default.conf \
@@ -25,7 +31,7 @@ RUN a2enmod rewrite headers \
     && a2enconf phplist
 
 # Copy composer definition first and install dependencies
-COPY composer.json composer.lock ./
+COPY composer.json composer.lock package.json yarn.lock ./
 
 # Install Composer
 ENV COMPOSER_ALLOW_SUPERUSER=1 \
@@ -53,6 +59,9 @@ RUN chown -R www-data:www-data var public \
     && find var -type d -exec chmod 775 {} \; \
     && find var -type f -exec chmod 664 {} \;
 
+# Build frontend assets once, during image build
+RUN composer run-script build-web-frontend-assets
+
 # Expose port and run Apache
 EXPOSE 80
 CMD ["apache2-foreground"]

README.md

@@ -151,6 +151,14 @@ You can get a list of all installed phpList modules with this command:
 composer run-script list-modules
 ```
 
+To compile and publish the `phplist/web-frontend` assets into
+`public/build` (used by the web frontend Twig templates),
+run:
+
+```bash
+composer run-script build-web-frontend-assets
+```
+
 
 ## Creating a .tar.gz package of this distribution
 

composer.json

@@ -48,8 +48,9 @@
         "phplist/rest-api": "dev-main",
         "phplist/web-frontend": "dev-main",
         "doctrine/orm": "^3.3",
-        "tatevikgr/rest-api-client": "dev-ISSUE-357",
-        "tatevikgr/rss-feed": "dev-main as 0.1.0"
+        "tatevikgr/rest-api-client": "dev-main",
+        "tatevikgr/rss-feed": "dev-main as 0.1.0",
+        "nelmio/cors-bundle": "^2.6"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6.33",
@@ -90,6 +91,10 @@
             "php bin/console cache:clear",
             "php bin/console cache:warmup"
         ],
+        "build-web-frontend-assets": [
+            "yarn install",
+            "yarn build:web-frontend"
+        ],
         "post-install-cmd": [
             "@create-directories",
             "@update-configuration"
@@ -104,6 +109,11 @@
         ]
     },
     "extra": {
+        "phplist/core": {
+            "bundles": [
+                "Nelmio\\CorsBundle\\NelmioCorsBundle"
+            ]
+        },
         "symfony-app-dir": "bin",
         "symfony-bin-dir": "bin",
         "symfony-var-dir": "var",