#1 - project skeleton (#15)

* #1 - project skeleton

* #1 - gitignore update

* #1 - fix

* #1 - delete .composer dir

* #1 - wip

* #1 - added readme

* #1 - readme fixes

* Update composer.json

Co-authored-by: Marcin Tracz <[email protected]>

* Update .env.example

Co-authored-by: Marcin Tracz <[email protected]>

* #1 - cr fixes

* #1 - changed readme name

* Apply suggestions from code review

Co-authored-by: Marcin Tracz <[email protected]>

* Update environment/dev/app/Dockerfile

Co-authored-by: Marcin Tracz <[email protected]>

* #1 - cr fixes

* Update resources/views/app.blade.php

Co-authored-by: Krzysztof Rewak <[email protected]>

* Update app/Http/Middleware/EncryptCookies.php

Co-authored-by: Krzysztof Rewak <[email protected]>

* #1 - cr fixes

* #1 - small fixes

* #1 - csf

* #1 - composer fix

* #1 - readme update

---------

Co-authored-by: Marcin Tracz <[email protected]>
Co-authored-by: Krzysztof Rewak <[email protected]>

.editorconfig

@@ -0,0 +1,18 @@
+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
+
+[docker-compose.yml]
+indent_size = 4

.env.ci

@@ -0,0 +1,16 @@
+APP_NAME=escooters
+APP_ENV=testing
+APP_KEY=base64:WVG2VcHt+a2uzCw7n1tVUBPyw2kof644d6EoYA/UUAg=
+APP_DEBUG=false
+APP_URL=http://escooters.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

@@ -0,0 +1,46 @@
+APP_NAME=Escooters
+APP_ENV=local
+APP_KEY=base64:sCsJw8z+d/4ymp0OvzSip2h4Vp2hZZhpV2uOxgTqP94=
+APP_DEBUG=true
+APP_URL=http://escooters.blumilk.localhost
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=pgsql
+DB_HOST=escooters-db-dev
+DB_PORT=5432
+DB_DATABASE=escooters
+DB_USERNAME=escooters
+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=escooters-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=3851
+DOCKER_INSTALL_XDEBUG=true
+DOCKER_DATABASE_HOST_PORT=3853
+DOCKER_MAILPIT_DASHBOARD_HOST_PORT=3856
+DOCKER_REDIS_HOST_PORT=3852
+
+DOCKER_HOST_USER_ID=1000

.eslintrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+    env: {
+        node: true,
+        'vue/setup-compiler-macros': true,
+    },
+    extends: [
+        'plugin:vue/base',
+        'eslint:recommended',
+        'plugin:vue/vue3-recommended',
+        'plugin:tailwindcss/recommended',
+    ],
+    rules: {
+        semi: ['error', 'never'],
+        quotes: ['error', 'single'],
+        indent: ['error', 2],
+        'block-spacing': ['error', 'always'],
+        'keyword-spacing': ['error'],
+        'padding-line-between-statements': [ 'error', {
+            blankLine: 'always', prev: '*', next: ['return', 'block-like'],
+        }],
+        'space-before-blocks': ['error', 'always'],
+        'eol-last': ['error', 'always'],
+        'vue/multi-word-component-names': 0,
+        'vue/first-attribute-linebreak': 0,
+        'vue/max-attributes-per-line': 0,
+        'vue/html-indent': ['error', 2],
+        'comma-dangle': ['error', 'always-multiline'],
+        'comma-spacing': ['error'],
+        'key-spacing': ['error'],
+        'object-curly-spacing': ['error', 'always'],
+        'tailwindcss/no-custom-classname': 0,
+        'vue/require-default-prop': 0,
+        'vue/padding-line-between-blocks': ['error', 'always'],
+        'vue/component-tags-order': ['error', {
+            'order': ['script', 'template', 'style'],
+        }],
+    },
+}

.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

@@ -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/worklflows/check-pr-title.yml

@@ -0,0 +1,12 @@
+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-20.04
+    steps:
+      - uses: blumilksoftware/[email protected]

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

@@ -0,0 +1,39 @@
+name: Test & lint JS codebase
+
+on:
+  pull_request:
+    branches: [ "main" ]
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - '**.js'
+      - '**.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-22.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-npm-dependencies-${{ hashFiles('package.lock') }}
+          restore-keys: ${{ runner.os }}-npm-dependencies
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - name: Instal npm dependencies
+        run: npm clean-install
+
+      - name: Run JS linter
+        run: npm run lint

.github/worklflows/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-22.04
+    services:
+      pgsql:
+        image: postgres:15.2-alpine3.17
+        env:
+          POSTGRES_DB: escooters
+          POSTGRES_USER: escooters
+          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/checkout@v3
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-composer-dependencies-${{ hashFiles('composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-dependencies
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        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

.gitignore

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

Makefile

@@ -0,0 +1,59 @@
+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)
+
+TEST_DATABASE_NAME=escooters-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'
+
+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=dev ${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