NFQ Akademija

Intro

Sveiki! Tai yra Jūsų startinis projekto "template". Šioje repositorijoje rasite Symfony 4.0.6 minimalų projekto paketą su jau paruoštais visais reikalingais failais ir įrankiais darbui:

• Lokalaus development'o aplinka (docker) (PHP 7.2, MySql DB, Nginx)
• Pradinis bundle (AppBundle) kartu su stiliaus failais.
• Įdiegtas bootstrap
• Asset'ų buildinimas (npm, yarn, sass)
• Travis CI template

Paleidimo instrukcija

Metai iš metų studentai maldavo jog galėtų dirbti su Windows'ais akademijos metu. Bet nepaisant nieko, tolerancijos ir palaikymo Windows operacinei niekada nebuvo ir nebus.

Perspėjimas: Itin kieti profesionalai nenaudoja niekam tikusių operacinių sistemų.

Reikės dokerio

Naudosime naujausią dokerio versiją, kuri įgalina virtualizaciją be Virtualbox ar Vmware. Tam reikės, kad jūsų kompiuterio procesorius palaikytų Hypervisor. Nėra dėl ko nerimauti, dabartiniai kompiuteriai kone visi turi šį palaikymą.

Parsisiunčiate ir įsidiegiate įrankį iš čia. Iškart įdiegus reikia pasidaryti, kad docker būtų galima naudoti be root teisių, kaip tai padaryti rasite čia.

Parsisiunčiate ir įsidiegiate docker-compose iš čia.

Taip pat reikia įsidiegti Kitematic. Šis įrankis padės geriau organizuoti dokerio konteinerius.

Versijų reikalavimai

• docker: 18.x-ce
• docker-compose: 1.20.1

Projekto paleidimas (projekto kūrimui lokaliai)

Parsisiunčiate šią repositoriją. Taip taip, viršuje kairėje rasite žalią mygtuką ant kurio parašyta "Download", tada pasirenkate zip failo parsisiuntimą.

Akademijos projektui nereikia forkinti, klonuoti ar dar išrasti kokių nors kitų veiksmų, tik parsisiųsti.

Extractinat turinį į savo mėgstamą projektų direktoriją.

Einate į šią direktoriją su terminalu. Paprastai bus komanda cd <path>.

• Susikuriate projekto viduje .env failą. Failą užpildote turiniu pateiktu iš env.dist:

  cp .env.dist .env
  

• Pasiruoškite infrastruktūrą:

  docker-compose up -d
  

Pasiruošiame frontend aplinką

• JavaScript/CSS įrankiams (atsidaryti atskirame lange)

docker-compose run --rm frontend.symfony

• Pirmą kartą (įsirašome JavaScript bibliotekas)

npm install --no-save

• Jei pakeitimai neatsinaujina (arba klaidos dėl build/css ar build/js):

yarn run encore dev --watch

Pasiruošiame backend aplinką

• PHP įrankiams (atsidaryti atskirame lange)

docker exec -it php.symfony bash

• Pirmą kartą paleidus (įsirašome PHP bibliotekas):

composer install

• Jei pakeitimai neatsinaujina:

bin/console cache:clear
bin/console assets:install

Pasižiūrime rezultatą

Atsidarome naršyklėje 127.0.0.1:8000

Jei nematote užrašo "NFQ Akademija", reiškia, kažkur susimovėte, tokiu atveju viską ištrinat ir kartojate iš naujo tol kol gausis. Kai prarasite visiškai viltį, kreipkitės į Google, o po to į mentorių.

Projekto paleidimas (palyginimui kaip atrodytų produkcijoje)

• Pasiruoškite infrastruktūrą (jei prieš tai leidote šią komandą, jos kartoti nereikia):

  docker-compose up -d
  

Pasiruošiame frontend aplinką

• JavaScript/CSS įrankiams (atsidaryti atskirame lange)

docker-compose run --rm frontend.symfony

• Pirmą kartą (įsirašome JavaScript bibliotekas)

npm install --no-save

• Jei pakeitimai neatsinaujina (skiriasi nuo dev aplinkos):

yarn run encore production

Pasiruošiame backend aplinką

• PHP įrankiams (atsidaryti atskirame lange, skiriasi nuo dev aplinkos)

docker exec -it prod.php.symfony bash

• Pirmą kartą paleidus (įsirašome PHP bibliotekas):

composer install

• Jei pakeitimai neatsinaujina (skiriasi nuo dev aplinkos):

bin/console cache:clear
bin/console assets:install

Pasižiūrime rezultatą

Atsidarome naršyklėje 127.0.0.1:8888

P.S. šalia galima atsidaryti ir palyginti su 127.0.0.1:8000

Kaip teisingai išjungti docker konteinerius?

Išjungiama su komanda:

docker-compose kill

Galima išjungti ir po vieną:

docker-compose kill <container name>

Kaip prisijungti prie MySql duomenų bazės?

mysql -uroot -h127.0.0.1 --port=3307 -p

Slaptažodžiui naudoti p9iijKcfgENjBWDYgSH7

Kaip pasiruošti produkcinei aplinkai?

• Pasikeiskite slaptažodžius: ieškokite failuose reikšmių prie DATABASE_URL= ir APP_SECRET=
• Pakeiskite parametrus nginx/apache serveryje. Žr. pavyzdį site.conf
• Įsitikinkite, kad reikalingos bibliotekos įrašytos į operacinę sistemą. Žr. pavyzdį php/Dockerfile
• Įsitikinkite, kad APP_ENV yra prod (tiek naudojant bin/console, tiek ateinantis per nginx į index.php)

Troubleshooting'as

Jeigu kažkas nutiko ne taip, na, atsirado raudona eilutė, ar tiesiog nutrūko ir nieko nerodo, neatsidaro naršyklėje svetainė, tai pirmas žingsnis būtų paleisti komandą:

docker-compose logs 

Nepamirškite, kad galima nurodyti norimą procesą ar filtruoti eilutes:

docker-compose logs mysql.symfony | grep Warning

Jei kažką su infrastrutkūrą žiauriai sugadinote, perkurti nuo nulio galima:

docker rm -f $(docker ps -aq)
docker rmi -f kickstartmaster_frontend.symfony
docker rmi -f kickstartmaster_prod.php.symfony
docker rmi -f kickstartmaster_php.symfony

Feedbackas

Jeigu taip nutiktų, kad repositorijoje, projekto template ar instrukcijoje rastumėte klaidą, tai nesišnibždėkite vieni tarp kitų, o sukurkite "issue". O jei atidarysite "pull requestą" su fixu, gausite iškart 1000 karmos taškų.