setup with boilerplate

.editorconfig

@@ -14,5 +14,8 @@ 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=gha-analyzer
+APP_ENV=testing
+APP_KEY=
+APP_DEBUG=false
+APP_URL=http://gha-analyzer.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,30 +1,48 @@
-APP_NAME=Laravel
+APP_NAME=gha-analyzer
+VITE_APP_NAME=gha-analyzer
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://gha-analyzer.blumilk.localhost
+
+APP_LOCALE=en
+APP_FALLBACK_LOCALE=en
+APP_FAKER_LOCALE=en_US
+
+APP_MAINTENANCE_DRIVER=file
+APP_MAINTENANCE_STORE=database
+
+BCRYPT_ROUNDS=12
 
 LOG_CHANNEL=stack
 LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 
-DB_CONNECTION=mysql
-DB_HOST=127.0.0.1
-DB_PORT=3306
-DB_DATABASE=laravel
-DB_USERNAME=root
-DB_PASSWORD=
+DB_CONNECTION=pgsql
+DB_HOST=gha-analyzer-db-dev
+DB_PORT=5432
+DB_DATABASE=gha-analyzer
+DB_USERNAME=gha-analyzer
+DB_PASSWORD=password
+DB_ROOT_PASSWORD=example
 
-BROADCAST_DRIVER=log
-CACHE_DRIVER=file
-FILESYSTEM_DISK=local
-QUEUE_CONNECTION=sync
-SESSION_DRIVER=file
+SESSION_DRIVER=redis
 SESSION_LIFETIME=120
+SESSION_ENCRYPT=false
+SESSION_PATH=/
+SESSION_DOMAIN=null
+
+BROADCAST_CONNECTION=log
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=redis
+
+CACHE_STORE=redis
+CACHE_PREFIX=
 
 MEMCACHED_HOST=127.0.0.1
 
-REDIS_HOST=127.0.0.1
+REDIS_CLIENT=phpredis
+REDIS_HOST=gha-analyzer-redis-dev
 REDIS_PASSWORD=null
 REDIS_PORT=6379
 
@@ -43,17 +61,11 @@ AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
 AWS_USE_PATH_STYLE_ENDPOINT=false
 
-PUSHER_APP_ID=
-PUSHER_APP_KEY=
-PUSHER_APP_SECRET=
-PUSHER_HOST=
-PUSHER_PORT=443
-PUSHER_SCHEME=https
-PUSHER_APP_CLUSTER=mt1
-
-VITE_APP_NAME="${APP_NAME}"
-VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
-VITE_PUSHER_HOST="${PUSHER_HOST}"
-VITE_PUSHER_PORT="${PUSHER_PORT}"
-VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
-VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+# DOCKER
+DOCKER_APP_HOST_PORT=63851
+DOCKER_DATABASE_HOST_PORT=63853
+DOCKER_MAILPIT_DASHBOARD_HOST_PORT=63854
+DOCKER_REDIS_HOST_PORT=63852
+DOCKER_INSTALL_XDEBUG=true
+
+DOCKER_HOST_USER_ID=1000

.github/CODEOWNERS

@@ -0,0 +1 @@
+@blumilksoftware/blumilk

.github/dependabot.yml

@@ -0,0 +1,46 @@
+version: 2
+
+updates:
+  - package-ecosystem: composer
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:30"
+      timezone: "Europe/Warsaw"
+    commit-message:
+      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-pr-title.yml

@@ -0,0 +1,14 @@
+name: Check PR Title
+on:
+  pull_request:
+    branches: [ "main" ]
+    types: [opened, edited, synchronize, ready_for_review, reopened]
+
+jobs:
+  check-pr-title:
+    name: Check PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: blumilksoftware/[email protected] # https://github.com/blumilksoftware/action-pr-title
+        with:
+          regex: '^(App\-\d+ )?- .+'

.github/workflows/test-and-lint-js.yml

@@ -0,0 +1,40 @@
+name: Test & lint JS codebase
+
+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/test-and-lint-php.yml

@@ -0,0 +1,63 @@
+name: Test & lint PHP codebase
+
+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.2-alpine3.18 # https://hub.docker.com/_/postgres
+        env:
+          POSTGRES_DB: gha-analyzer
+          POSTGRES_USER: gha-analyzer
+          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.3
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, pdo_pgsql, intl
+          coverage: none
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Run PHP linter
+        run: composer cs
+
+      - name: Execute tests
+        run: php artisan test --env=ci

.gitignore

@@ -1,19 +1,21 @@
-/.phpunit.cache
 /node_modules
-/public/build
 /public/hot
 /public/storage
-/storage/*.key
+/public/js/
+/public/css/
+/public/mix-manifest.json
 /vendor
 .env
 .env.backup
-.env.production
 .phpunit.result.cache
+docker-compose.override.yml
 Homestead.json
 Homestead.yaml
-auth.json
 npm-debug.log
 yarn-error.log
-/.fleet
-/.idea
-/.vscode
+google-credentials.json
+.idea/
+.vscode/
+.composer
+/public/build/
+supervisord.pid

Makefile

@@ -0,0 +1,66 @@
+export COMPOSE_DOCKER_CLI_BUILD = 1
+export DOCKER_BUILDKIT = 1
+
+include .env
+
+SHELL := /bin/bash
+
+DOCKER_COMPOSE_FILE = docker-compose.yaml
+DOCKER_COMPOSE_APP_CONTAINER = app
+DOCKER_COMPOSE_DATABASE_CONTAINER = database
+
+CURRENT_USER_ID = $(shell id --user)
+CURRENT_USER_GROUP_ID = $(shell id --group)
+CURRENT_DIR = $(shell pwd)
+
+DATABASE_USERNAME=gha-analyzer
+TEST_DATABASE_NAME=gha-analyzer-test
+
+init: check-env-file
+	@make build \
+    && make run \
+	&& docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash "./environment/dev/scripts/init.sh" \
+	&& make create-test-db
+
+check-env-file:
+	@if [ ! -f ".env" ]; then \
+	  echo "Create .env file and adjust." ;\
+	  exit 1;\
+	fi; \
+
+build:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} build --pull
+
+run:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} up --detach
+
+stop:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} stop
+
+restart: stop run
+
+shell:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash
+
+shell-root:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec ${DOCKER_COMPOSE_APP_CONTAINER} bash
+
+test:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} composer test
+
+fix:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'composer csf'
+
+analyse:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'composer analyse'
+
+dev:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} bash -c 'npm run dev'
+
+queue:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec --user "${CURRENT_USER_ID}:${CURRENT_USER_GROUP_ID}" ${DOCKER_COMPOSE_APP_CONTAINER} php artisan queue:work
+
+create-test-db:
+	@docker compose --file ${DOCKER_COMPOSE_FILE} exec ${DOCKER_COMPOSE_DATABASE_CONTAINER} bash -c 'createdb --username=${DATABASE_USERNAME} ${TEST_DATABASE_NAME} &> /dev/null && echo "Created database for tests (${TEST_DATABASE_NAME})." || echo "Database for tests (${TEST_DATABASE_NAME}) exists."'
+
+.PHONY: init check-env-file build run stop restart shell shell-root test fix create-test-db queue analyse dev