PHP School Cloud

.docker/files/php-school-fpm/Dockerfile

@@ -1,18 +1,22 @@
-FROM php:8.1-fpm
+FROM php:8.3-fpm AS prod
 
 RUN apt-get -qq update && apt-get install -qqy git zlib1g-dev libzip-dev \
 	&& rm -rf /var/lib/apt/lists/* \
-	&& docker-php-ext-install pdo pdo_mysql zip
+	&& docker-php-ext-install pdo pdo_mysql zip sockets
 
 # Composer
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 
-#RUN pecl install xdebug && docker-php-ext-enable xdebug
-#ADD .docker/etc/php-xdebug.ini /usr/local/etc/php/conf.d/php-xdebug.ini
-
 COPY . /var/www/html
 WORKDIR /var/www/html
 
-RUN cd /var/www/html && composer install -q --no-dev -o
+COPY --from=php:8.1-cli /usr/local/bin/php-cgi /usr/local/bin/php-cgi
+
+RUN cd /var/www/html
+
+CMD ["php-fpm"]
+
+FROM prod AS debug
 
-CMD ["php-fpm"]
+RUN pecl install xdebug && docker-php-ext-enable xdebug
+ADD .docker/etc/php-xdebug.ini /usr/local/etc/php/conf.d/php-xdebug.ini

.env.dist

@@ -1,10 +1,13 @@
-MYSQL_HOST=localhost
+MYSQL_HOST=db
 MYSQL_DATABASE=phpschool
 MYSQL_USER=phpschool
 MYSQL_PASSWORD=phpschool
 SEND_GRID_API_KEY=sendgripapikey
 [email protected]
-REDIS_HOST=localhost
-CACHE.ENABLE=true
-CACHE.FPC.ENABLE=true
-DISPLAY_ERRORS=false
+REDIS_HOST=redis
+CACHE.ENABLE=false
+DISPLAY_ERRORS=true
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+GITHUB_TOKEN=
+DEV_MODE=true

.eslintrc.cjs

@@ -0,0 +1,17 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  },
+  env: {
+    node: true
+  }
+}

.github/workflows/eslint.yml

@@ -0,0 +1,27 @@
+name: PhpSchool.io
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master, online ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Eslint
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install NPM Dependencies
+        run: npm ci --no-audit --no-fund --prefer-offline
+
+      - name: Eslint
+        run: npm run lint

.github/workflows/phpschool.io.yml → .github/workflows/php.yml

@@ -4,35 +4,35 @@ on:
   push:
     branches: [ master ]
   pull_request:
-    branches: [ master ]
+    branches: [ master, online ]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        php: [8.1]
+        php: [8.2, 8.3]
 
     name: PHP ${{ matrix.php }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          tools: composer:v2
+          tools: composer:v2, cs2pr
 
-      - name: Install Dependencies
+      - name: Install PHP Dependencies
         run: composer install --prefer-dist
 
       - name: Run phpunit tests
         run:  composer phpunit
 
       - name: Run phpcs
-        run: composer cs
+        run: composer cs:ci
 
-      - name: Run psalm
-        run: composer static
+      - name: Run PHPStan
+        run: composer static

.github/workflows/prettier.yml

@@ -0,0 +1,27 @@
+name: PhpSchool.io
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master, online ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Prettier
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install NPM Dependencies
+        run: npm ci --no-audit --no-fund --prefer-offline
+
+      - name: Prettier
+        run: npm run prettier:ci

.gitignore

@@ -1,20 +1,25 @@
 .idea
 node_modules
 .DS_Store
+.php-cs-fixer.cache
 npm-debug.log
 /vendor/
 /logs/*
 !/logs/README.md
 /cache/
 /config/database.yml
 /.phpunit.result.cache
-
+/*.sql
 .docker/db/*
 .docker/mysql/*
 
+/public/dist/**/*.*
+!/public/dist/.gitkeep
 /public/workshops.json
 /public/uploads
 /public/blog
 .env
 /var
-/log
+/log
+
+/assets/.vite-ssg-temp/

.php-cs-fixer.dist.php

@@ -0,0 +1,15 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__ . '/src')
+    ->in(__DIR__ . '/test')
+    ->in(__DIR__ . '/app')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PER-CS2.0' => true,
+        'declare_strict_types' => true,
+        'no_unused_imports' => true,
+    ])
+    ->setFinder($finder);

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 4,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

README.md

@@ -1,45 +1,73 @@
 ## Install
 
-You will need `composer`, `gulp` and `docker`.
+You will need `composer`, `node` and `docker`.
 
 ```shell
-composer install
 npm install
+npm run build
 cp .env.dist .env
 docker-compose build
 ```
 
 ## Run
 ```shell
 docker-compose up -d
+docker compose exec php composer install
 ```
 
 ### Create DB Scheme
 ```shell
 docker compose exec php composer app:db:update
 ```
 
+### Import DB
+```shell
+docker-compose exec -T db mysql -uroot phpschool -proot < phpschool.sql
+```
+
 ### Generate Blog
 ```shell
 docker compose exec php composer app:gen:blog
 ```
 
 Then navigate to `http://localhost` !
 
-Pages are cached on first view.
-If you need to clear the cache, run `docker compose exec php composer app:cc`.
+## Build CSS & JS
 
-## Build CSS
+This needs to be done for the main website (non cloud) to run in development mode.
 
 ```shell
-gulp sass
+npm run build
 ```
 
-## Build SVG's
+## Building CSS & JS for cloud dev
+
+The cloud styles and JS are built using `vite.js` and therefore has a dev/watcher mode with hot/live reloading.
+
+Run:
+
 ```shell
-gulp svg
+npm run dev
 ```
 
+You will also need to symlink the image directory:
+
+```shell
+ln -s ../../assets/img/cloud public/img/cloud
+````
+
+## For GitHub login
+
+Add `127.0.0.1 www.phpschool.local` to `/etc/hosts`
+
+Create a GitHub oauth App:
+
+Application Name: PHP School Local
+Homepage: http://www.phpschool.local
+Authorization Callback URL: http://www.phpschool.local/student-login: 
+
+Take the client secret and client ID and place them in your `.env` file under the keys: `GITHUB_CLIENT_ID` & `GITHUB_CLIENT_SECRET`.
+
 ### View cache keys
 
 ```shell
@@ -49,7 +77,7 @@ docker-compose exec redis redis-cli keys '*'
 ### Clear cache
 
 ```shell
-docker compose exec php composer app:cc
+docker-compose exec php composer app:cc
 ```
 
 ## Deploy