Update site template

.editorconfig

@@ -5,12 +5,14 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
+trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = tab
 indent_size = 4
 
 # Markdown
 [*.{md,markdown}]
+trim_trailing_whitespace = false
 indent_style = space
 indent_size = 2
 

.env

@@ -1,12 +1,23 @@
 COMPOSE_PROJECT_NAME='fluffevent-help'
 IMAGES_PREFIX='fluffevent-help'
 
-# Override these values with your own in `.env.local`:
+# -- Override the values below with your own in `.env.local`.
+# -- Leave values empty to use defaults.
 
-# HTTP ports
-HTTP_PORT='' # Exposed port
-HTTP_DOCKER_PORT='' # Container port
+# Docker ports configuration
+# (host ports: "*_PORT"; container ports: "*_DOCKER_PORT")
+HTTP_PORT=''
+HTTP_DOCKER_PORT=''
 
-# Application configuration
+# Deployment configuration
 GITHUB_REPOSITORY_URL=''
 GITHUB_SHA=''
+VERSION_TAG=''
+
+# Astro configuration
+ASTRO_SITE_URL=''
+ASTRO_BASE_PATH=''
+ASTRO_ASSETS_PREFIX=''
+
+# Application configuration
+# Add env vars for your application here.

.env.cli

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME='fluffevent-help-cli'

.github/workflows/check.yml

@@ -1,16 +1,26 @@
 name: Check CI
 
+# GitHub variables:
+# - VERSION_TAG
+# - ASTRO_SITE_URL
+# - ASTRO_BASE_PATH
+# - ASTRO_ASSETS_PREFIX
+
+# GitHub secrets: N/A
+
 on:
 
   # Run on pull requests to primary branches
   pull_request:
     branches:
       # Production
       - main
+      # Staging
+      - staging
       # Development
       - dev
     paths:
-      # CI files
+      # CI/CD files
       - '.github/workflows/check.yml'
       - 'docker-compose.yml'
       - 'docker-compose.cicd.yml'
@@ -21,7 +31,7 @@ on:
   # Run on manual triggers
   workflow_dispatch:
 
-# Set GITHUB_TOKEN permissions for the workflow
+# Set default GITHUB_TOKEN permissions for the workflow
 permissions:
   contents: read
 
@@ -36,7 +46,7 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    timeout-minutes: 20
 
     steps:
 
@@ -77,16 +87,27 @@ jobs:
 
       - name: Build for production
         env:
+          # Build configuration
+          BUILD_CHECK: 'true' # Run type checks
+          # Deployment configuration
           GITHUB_REPOSITORY_URL: https://github.com/${{ github.repository }}
           GITHUB_SHA: ${{ github.sha }}
-          BUILD_CHECK: "true" # Run type checks
+          VERSION_TAG: ${{ vars.VERSION_TAG }}
+          # Astro configuration
+          ASTRO_SITE_URL: ${{ vars.ASTRO_SITE_URL }}
+          ASTRO_BASE_PATH: ${{ vars.ASTRO_BASE_PATH }}
+          ASTRO_ASSETS_PREFIX: ${{ vars.ASTRO_ASSETS_PREFIX }}
+          # Application configuration
+          # Add env vars for your application here.
         run: |
           # docker compose build
+          echo '::group::Build details'
           export DOCKER_UID="$(id -u)"
           docker compose \
             -f ./docker-compose.yml -f ./docker-compose.cicd.yml \
             --env-file .env \
             build
+          echo '::endgroup::'
 
       - name: Copy application files
         run: |
@@ -101,5 +122,5 @@ jobs:
         run: |
           # Check application files
           [ -d ./app/dist ] && [ $(ls -1 ./app/dist | wc -l) -gt 0 ] \
-            && echo "Application files found" \
-            || ( echo "No application files found" && exit 1 )
+            && echo 'Application files found' \
+            || ( echo 'No application files found' && exit 1 )

.github/workflows/deploy.yml

@@ -1,5 +1,13 @@
 name: Deploy CD
 
+# GitHub variables:
+# - VERSION_TAG
+# - ASTRO_SITE_URL
+# - ASTRO_BASE_PATH
+# - ASTRO_ASSETS_PREFIX
+
+# GitHub secrets: N/A
+
 on:
 
   # Run on push on production branches
@@ -8,7 +16,7 @@ on:
       # Production
       - main
     paths:
-      # CI files
+      # CI/CD files
       - '.github/workflows/deploy.yml'
       - 'docker-compose.yml'
       - 'docker-compose.cicd.yml'
@@ -19,7 +27,7 @@ on:
   # Run on manual triggers
   workflow_dispatch:
 
-# Set GITHUB_TOKEN permissions for the workflow
+# Set default GITHUB_TOKEN permissions for the workflow
 permissions:
   contents: read
 
@@ -34,11 +42,11 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    timeout-minutes: 20
 
     steps:
 
-      # Steps dependencies
+      # Dependency steps
 
       - name: Checkout
         uses: actions/checkout@v4
@@ -75,9 +83,18 @@ jobs:
 
       - name: Build for production
         env:
+          # Build configuration
+          BUILD_CHECK: 'false' # Skip type checks
+          # Deployment configuration
           GITHUB_REPOSITORY_URL: https://github.com/${{ github.repository }}
           GITHUB_SHA: ${{ github.sha }}
-          BUILD_CHECK: "false" # Skip type checks
+          VERSION_TAG: ${{ vars.VERSION_TAG }}
+          # Astro configuration
+          ASTRO_SITE_URL: ${{ vars.ASTRO_SITE_URL }}
+          ASTRO_BASE_PATH: ${{ vars.ASTRO_BASE_PATH }}
+          ASTRO_ASSETS_PREFIX: ${{ vars.ASTRO_ASSETS_PREFIX }}
+          # Application configuration
+          # Add env vars for your application here.
         run: |
           # docker compose build
           export DOCKER_UID="$(id -u)"
@@ -112,8 +129,8 @@ jobs:
 
     # Set GITHUB_TOKEN permissions for the job
     permissions:
-      pages: write
       id-token: write
+      pages: write
 
     # Set deployment environment
     environment:
@@ -122,6 +139,8 @@ jobs:
 
     steps:
 
+      # Execution steps
+
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

.gitignore

@@ -1,7 +1,7 @@
 # -- Generic rules:
 
 # Environment files
-.env*.local
+.env*.local*
 
 # Temporary files
 ._*
@@ -41,6 +41,12 @@ dist/
 .astro/
 .vite/
 
+# Playwright
+test-results/
+playwright-report/
+blob-report/
+playwright/.cache/
+
 # Application environment files
 */**/.env*
 

README.md

@@ -3,3 +3,34 @@
 The help and documentation website for [Fluff Event](https://fluffEvent.fr).
 
 Visit this website at [help.fluffEvent.fr](https://help.fluffEvent.fr).
+
+
+## Getting started
+
+### Development
+
+Use this command to run the site locally for development:
+
+```sh
+docker compose watch
+# or: docker compose up
+```
+
+Using `watch`, you'll benefit from file changes watching for sync & rebuild.
+
+Use [DockerC](https://github.com/matiboux/dockerc) for shortened commands: `dockerc - @w`.
+
+The site will be available at [http://localhost:8080](http://localhost:8080).
+
+### Production
+
+Use this command to run the site locally for production:
+
+```sh
+docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
+# or: docker compose -f docker-compose.yml up -d
+```
+
+Use [DockerC](https://github.com/matiboux/dockerc) for shortened commands: `dockerc prod`.
+
+The site will be available at [http://localhost:8080](http://localhost:8080).

app/.dockerignore

@@ -1,7 +1,7 @@
 # -- Generic rules:
 
 # Environment files
-.env*.local
+.env*.local*
 
 # Temporary files
 ._*
@@ -34,12 +34,19 @@ Thumbs.db
 
 # Node.js
 node_modules/
+.pnpm-store/
 dist/
 
 # Astro
 .astro/
 .vite/
 
+# Playwright
+test-results/
+playwright-report/
+blob-report/
+playwright/.cache/
+
 # Application environment files
 */**/.env*
 

app/.starlight-template

@@ -0,0 +1 @@
+2b5292214e55efe3fd229b20efb2688c02ba6230