Documentation/readme

.commitlintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
+}

.env.example

@@ -0,0 +1,22 @@
+NODE_ENV=development
+
+DATABASE_CLIENT=mysql2
+DATABASE_USERNAME=vim
+DATABASE_PASSWORD=super-secret
+DATABASE_PORT=3306
+DATABASE_SSL=false
+
+WEB_DATABASE_NAME=vim
+NEXT_PRIVATE_STANDALONE=true
+NEXTAUTH_SECRET=testsecret
+
+CMS_DATABASE_NAME=vim_cms
+CMS_HOST=0.0.0.0
+CMS_PORT=1337
+CMS_APP_KEYS=testkey1,testkey2
+CMS_API_TOKEN_SALT=testtoken
+CMS_ADMIN_JWT_SECRET=testsecret
+CMS_JWT_SECRET=testsecret
+CMS_TRANSFER_TOKEN_SALT=testtoken
+CMS_DISABLE_UPDATE_NOTIFICATION=false
+CMS_TELEMETRY_DISABLED=true

.github/pull_request_template.md

@@ -0,0 +1,42 @@
+<!--
+  For Work In Progress Pull Requests, please use the Draft PR feature,
+  see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
+
+  Before submitting a Pull Request, please ensure you've done the following:
+  - 👷️ Create small PRs.
+  - 📝 Use descriptive commit messages.
+  - 📗 Update any related documentation and include any relevant screenshots.
+-->
+
+## Description
+<!--- Describe your changes in detail --> 
+
+
+## What type of PR is this? (check all applicable)
+- [ ] 🍕 Feature
+- [ ] 🐛 Bug Fix
+- [ ] 📝 Documentation Update
+- [ ] 🎨 Style
+- [ ] 🧑‍💻 Code Refactor
+- [ ] 🤖 Build
+- [ ] 🔁 CI
+- [ ] 📦 Chore
+- [ ] ⏩ Revert
+
+
+## Related Issues and Pull Requests
+**Fixes:** #(issue/ pr number) <br/>
+**Closes:** #(issue/ pr number) <br/>
+**Depends on:** #(issue/ pr number)
+
+
+## Mobile & Desktop Screenshots/Recordings (if applicable)
+<!--- Drag and drop your screenshots or recordings here -->
+### Mobile
+
+### Desktop
+
+## [optional] Design Documents or Screenshots
+<!--- If applicable, add design documents or screenshots to describe the changes visually -->
+
+

.github/workflows/build-push-cms.yml

@@ -0,0 +1,47 @@
+name: Build and Push CMS Docker Image
+
+on:
+  push:
+    branches:
+      - main
+      - development
+      - 'feature/**'
+
+jobs:
+  push_to_registries:
+    name: Push Docker image to GHCR
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@f7b4ed12385588c3f9bc252f0a2b520d83b52d48
+        with:
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+          images: |
+            ghcr.io/${{ github.repository }}/cms
+
+      - name: Build and push Docker images
+        uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
+        with:
+          context: ./cms
+          file: ./cms/Dockerfile.prod
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: CMS_URL=${{vars.CMS_URL}}

.github/workflows/build-push-web.yml

@@ -0,0 +1,48 @@
+name: Build and Push Web Docker Image
+
+on:
+  push:
+    branches:
+      - main
+      - development
+      - 'feature/**'
+    paths:
+      - web/**
+
+jobs:
+  push_to_registries:
+    name: Push Docker image to GHCR
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@f7b4ed12385588c3f9bc252f0a2b520d83b52d48
+        with:
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+          images: |
+            ghcr.io/${{ github.repository }}/web
+
+      - name: Build and push Docker images
+        uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
+        with:
+          context: ./web
+          file: ./web/Dockerfile.prod
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/deploy-vm.yml

@@ -0,0 +1,52 @@
+name: Deploy Docker Images
+
+on:
+  push:
+    branches:
+      - main
+      - development
+  workflow_run:
+    workflows:
+      - Build and Push Web Docker Image
+      - Build and Push CMS Docker Image
+    branches:
+      - development
+    types:
+      - completed
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: setup environment file
+      run: |
+        test -f .env || cp .env.example .env
+
+    - name: copy files to server
+      uses: appleboy/[email protected]
+      with:
+        host: ${{ secrets.SSH_HOST }}
+        username: ${{ secrets.SSH_USER }}
+        key: ${{ secrets.SSH_KEY }}
+        source: "./docker-compose.dev.yml,./.env"
+        target: "~/${{ github.event.repository.name }}/"
+
+    - name: pull & start container images
+      uses: appleboy/[email protected]
+      with:
+        host: ${{ secrets.SSH_HOST }}
+        username: ${{ secrets.SSH_USER }}
+        key: ${{ secrets.SSH_KEY }}
+        script_stop: true
+        script: |
+          cd ~/${{ github.event.repository.name }}/
+          echo ${{ secrets.GITHUB_TOKEN }} | docker login ghcr.io -u ${{github.actor}} --password-stdin
+          docker compose -f docker-compose.dev.yml pull
+          docker compose -f docker-compose.dev.yml down
+          docker compose -f docker-compose.dev.yml up -d --wait --no-build --force-recreate
+          docker compose -f docker-compose.dev.yml logs -t -n 50

.github/workflows/verify-cms.yml

@@ -0,0 +1,34 @@
+name: Verify CMS
+
+on:
+  push:
+    branches:
+      - main
+      - development
+      - 'feature/**'
+    paths:
+      - cms/**
+  pull_request:
+    branches:
+      - main
+      - development
+    paths:
+      - cms/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      - name: Install cms dependencies
+        run: cd cms && npm ci
+      - name: Lint cms
+        run: cd cms && npm run lint
+      - name: Build cms
+        run: cd cms && npm run build

.github/workflows/verify-web.yml

@@ -0,0 +1,36 @@
+name: Verify Web
+
+on:
+  push:
+    branches:
+      - main
+      - development
+      - 'feature/**'
+    paths:
+      - web/**
+  pull_request:
+    branches:
+      - main
+      - development
+      - 'feature/**'
+    paths:
+      - web/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CMS_API: ${{ vars.CMS_API }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      - name: Install web dependencies
+        run: cd web && npm ci
+      - name: Lint web
+        run: cd web && npm run lint
+      - name: Build web
+        run: cd web && npm run build

.gitignore

@@ -0,0 +1,2 @@
+.env
+node_modules

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

README.md

@@ -11,6 +11,12 @@ Soon there will be a test system where you can follow the current status success
 
 Of course, we will involve you, the community, in the design by collecting ideas and feedback.
 
+# Getting started
+
+To initially build the project on your local computer, you can use the docker-compose.local.yml file, e.g. with docker compose -f docker-compose.local.yml up --build 
+
+For more information about the headless CMS used in this project, visit the official documentation: https://docs.strapi.io/
+
 
 # Requirements
 

cms/.dockerignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+build

cms/.env.example

@@ -0,0 +1,11 @@
+STRAPI_DISABLE_UPDATE_NOTIFICATION=false
+STRAPI_TELEMETRY_DISABLED=true
+NODE_ENV=development
+
+HOST=0.0.0.0
+PORT=1337
+APP_KEYS="toBeModified1,toBeModified2"
+API_TOKEN_SALT=tobemodified
+ADMIN_JWT_SECRET=tobemodified
+TRANSFER_TOKEN_SALT=tobemodified
+JWT_SECRET=tobemodified

cms/.eslintignore

@@ -0,0 +1 @@
+src/admin/

cms/.eslintrc.json

@@ -0,0 +1,24 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint", "prettier", "unused-imports"],
+    "ignorePatterns": ["node_modules/", "build/", "dist/", "public/"],
+    "parserOptions": {
+        "project": "./tsconfig.json",
+        "ecmaVersion": 2018,
+        "sourceType": "module"
+    },
+    "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+    "env": {
+        "commonjs": true,
+        "es6": true,
+        "node": true,
+        "browser": false
+    },
+    "globals": {
+        "strapi": true
+    },
+    "rules": {
+        "prettier/prettier": "error",
+        "no-console": 0
+    }
+}