#198 - Laravel application boilerplate

.editorconfig

@@ -0,0 +1,21 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[*.{js,ts,vue,css}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.ci

@@ -0,0 +1,16 @@
+APP_NAME=website
+APP_ENV=testing
+APP_KEY=base64:WVG2VcHt+a2uzCw7n1tVUBPyw2kof644d6EoYA/UUAg=
+APP_DEBUG=false
+APP_URL=http://website.blumilk.localhost
+
+LOG_CHANNEL=stack
+LOG_LEVEL=debug
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=array
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=array
+SESSION_LIFETIME=120
+MAIL_MAILER=array

.env.example

@@ -1,8 +1,47 @@
-VITE_CONTACT_FORM_URL='https://docs.google.com/forms/u/0/d/e/00000000000000000000000000000000000000000000000000000000'
-VITE_CONTACT_FORM_EMAIL_NAME='emailAddress'
-VITE_CONTACT_FORM_QUESTION_NAME='entry.0000000000'
+APP_NAME=website
+VITE_APP_NAME=website
+APP_ENV=local
+APP_KEY=base64:sCsJw8z+d/4ymp0OvzSip2h4Vp2hZZhpV2uOxgTqP94=
+APP_DEBUG=true
+APP_URL=http://website.blumilk.localhost
 
-VITE_MAPBOX_STYLE='mapbox://styles/krewak/ckjhf6g1qbww719p1e33pgm84'
-VITE_MAPBOX_TOKEN=''
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
 
-BASE_URL='http://0.0.0.0:0000'
+DB_CONNECTION=pgsql
+DB_HOST=website-db-dev
+DB_PORT=5432
+DB_DATABASE=website
+DB_USERNAME=website
+DB_PASSWORD=password
+DB_ROOT_PASSWORD=example
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=redis
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=redis
+SESSION_DRIVER=redis
+SESSION_LIFETIME=120
+
+REDIS_HOST=website-redis-dev
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailpit
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="[email protected]"
+MAIL_FROM_NAME="${APP_NAME}"
+
+# DOCKER
+DOCKER_APP_HOST_PORT=34620
+DOCKER_DATABASE_HOST_PORT=34621
+DOCKER_MAILPIT_DASHBOARD_HOST_PORT=34622
+DOCKER_REDIS_HOST_PORT=34623
+DOCKER_INSTALL_XDEBUG=true
+
+DOCKER_HOST_USER_ID=1000

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.github/dependabot.yml

@@ -1,10 +1,46 @@
 version: 2
+
 updates:
-  - package-ecosystem: "npm"
+  - package-ecosystem: composer
     directory: "/"
     schedule:
-      interval: "monthly"
+      interval: monthly
       time: "06:30"
+      timezone: "Europe/Warsaw"
     commit-message:
-      prefix: "- "
+      prefix: "- (php) "
+    target-branch: main
+    open-pull-requests-limit: 1
+
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:30"
+      timezone: "Europe/Warsaw"
+    commit-message:
+      prefix: "- (js) "
+    target-branch: main
+    open-pull-requests-limit: 1
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:30"
+      timezone: "Europe/Warsaw"
+    commit-message:
+      prefix: "- (github actions) "
+    target-branch: main
+    open-pull-requests-limit: 1
+
+  - package-ecosystem: docker
+    directory: "/environment/dev/app"
+    schedule:
+      interval: monthly
+      time: "06:30"
+      timezone: "Europe/Warsaw"
+    commit-message:
+      prefix: "- (docker dev) "
+    target-branch: main
     open-pull-requests-limit: 1

.github/workflows/check.js.yml

@@ -0,0 +1,40 @@
+name: "Checking app: testing and linting PHP"
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - '**.js'
+      - '**.ts'
+      - '**.vue'
+      - 'package.json'
+      - 'package.lock'
+
+jobs:
+  test-and-lint-js:
+    name: Test & lint JS codebase
+    timeout-minutes: 10
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/[email protected] # https://github.com/actions/checkout
+
+      - name: Cache dependencies
+        uses: actions/[email protected] # https://github.com/actions/cache
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-npm-dependencies-${{ hashFiles('package.lock') }}
+          restore-keys: ${{ runner.os }}-npm-dependencies
+
+      - name: Set up node
+        uses: actions/[email protected] # https://github.com/actions/setup-node
+        with:
+          node-version: 21
+
+      - name: Instal npm dependencies
+        run: npm clean-install
+
+      - name: Run JS linter
+        run: npm run lint

.github/workflows/check.php.yml

@@ -0,0 +1,63 @@
+name: "Checking app: testing and linting PHP"
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - '**.php'
+      - 'composer.json'
+      - 'composer.lock'
+      - 'phpunit.xml'
+      - 'env.ci'
+
+jobs:
+  test-and-lint-php:
+    name: Test & lint PHP codebase
+    timeout-minutes: 10
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    services:
+      pgsql:
+        image: postgres:16.1-alpine3.18 # https://hub.docker.com/_/postgres
+        env:
+          POSTGRES_DB: website
+          POSTGRES_USER: website
+          POSTGRES_PASSWORD: password
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 3s
+          --health-timeout 3s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/[email protected] # https://github.com/actions/checkout
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Cache dependencies
+        uses: actions/[email protected] # https://github.com/actions/cache
+        with:
+          path: vendor
+          key: ${{ runner.os }}-composer-dependencies-${{ hashFiles('composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-dependencies
+
+      - name: Setup PHP
+        uses: shivammathur/[email protected] # https://github.com/shivammathur/setup-php
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_pgsql, intl
+          coverage: none
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-interaction --no-suggest
+
+      - name: Run PHP linter
+        run: composer cs
+
+      - name: Execute tests
+        run: php artisan test --env=ci