1) Telepítés

Fejlesztői környezet (dev environment)

A Miserend.hu forráskódját a master ágban a Symfony alkotja. A mappák rendszere a Symfony framework rendszerét követi, így nagyrészt a Symfony dokumentációjában leírtak az irányadóak. Ebben a leírásban, csak a kulcs momentumokat részletezzük, helyenként hivatkozva a keretrendszer dokumentációját.

Telepítés

Lehetőség van a weboldalt docker konténerben futtatni. Ez esetben létrejön egy mysql adatbázis, egy phpmyadmin, egy mailcatcher, egy builder konténer és maga a weboldal. Beállítást követően az alábbi paranccsal lehet elindítani: docker compose --env-file .env.local -p miserend up Természetesen lehetséges saját igények szerint módoítani a docker-compose.yml, erre a javasolt módszer a compose fájl lemásolása és pl .docker mappába helyezése: .docker/docker-compose.local.yml A docker-compose környezeti változók mentén történő, minimális finomhangolását, a Symfony beállítását is tartalmazó, alább részletezett .env.local fájlban lehet megtenni.

Symfony beállítása

A Symfony beállítását a .env fájlokkal lehet. A Symfonynál az alábbi fájlokban lehet létrehozni a különféle környezetek beállításait:

.env.local
.env.{environment}.local

Ez célszerűen egy másolat a .env fájlból (.env.local néven) és annak tetszőleges módosítása.

Adatbázis beállítás

Az adatbázis kapcsolatot a DATABASE_URL környezeti változó tartalmazza: <driver>://<username>:<password>@<host>:<port>/<database> Kötelező a verziót is megadni a serverVersion paraméterrel, illetve célszerű a karakterkódolást is, a charset paraméterben. Példa: DATABASE_URL="mysql://user:pw@127.0.0.1:3306/miserend?serverVersion=5.7.x&charset=utf8" A pontos verziót Docker Hub oldalról lehet kinézni.

Fájlok megnyitása fejlesztői környezetben (IDE)

Olyan szerkesztők esetén, amik támogatják a fájlok megnyitását böngészőből, lehetőség van beállítani a Symfony-t, hogy a dev toolbar-ról és a profiler környezetből, közvetlenül megnyissa a szerkesztőben. Ehhez az alábbi környezeti változót kell felvenni: SYMFONY_IDE="phpstorm://open?file=%f&line=%l&/miserend/>/Users/username/folder/to/source/miserend.hu/" A beállítás lehetőségeit a Symfony dokumentációja részletezi (a dokumentáció a framework.yaml beállításáról ír, de a SYMFONY_IDE környezeti változó tartalma azonos, és célszerű ezt használni az IDE beállítására). Néhány szerkesztő amit fogadni tudja a fájlmegnyitást: phpstorm, sublime, textmate, macvim, emacs, atom és vscode

miserend-build konténer és a webpack beállítás

A Webpack felelős azért, hogy az sass fájlokból css legyen és a javascript fájlokat is kompatibilis módon újrafordítsa (babel segítségével). Továbbá a Webpack verziózza az elkészült fájlokat és így garantálja, hogy frissülés esetén a kliensek azonnal a legfrissebb változatot lássák. Fejlesztői környezetben egy build szerver fut folyamatosan, figyeli a változásokat és újratölti a weboldalt változás esetén. Azért, hogy a prod környezetben ne legyen port nyitva, a build szerver portját külön egy docker-compose.override.yml fájlban kell definiálni:

version: "3.8"

services:
  miserend-build:
    ports:
      - ${MISEREND_WEBPACK_DEV_SERVER_PORT}:${MISEREND_WEBPACK_DEV_SERVER_PORT}

Ezzel együtt a .env.local fájlba fel kell venni a MISEREND_WEBPACK_DEV_SERVER_PORT értékét:

MISEREND_WEBPACK_DEV_SERVER_PORT=8082

Régi rendszer beállítása

A régi rendszer beállítása a config/config.php fájlban történik. A fájl tartalmához a mintát a config/config.dist.php szolgáltatja, ezt kell másolni és testre szabni.