/symfony-contacts-api

Primary LanguagePHP

Symfony API

This is Docker based Symfony 5.0.8 app and MySQL 8.0 DB.

API includes:

  • Dockerfile from webdevops/php-nginx:7.4
  • docker-compose v. 3.7
  • PHP 7.4 + nginx
  • Composer 1.10.6
  • Symfony 5.0.8
  • MySQL 8.0

First run

  • ./run up
    • Runs docker-compose up -d (builds new image if not found).
    • Fixes difference of Docker EOL configuration between Windows and Unix/Mac.
  • ./run migrate
    • Runs migration and fixtures for development purpose

Next runs

  • ./run up

Stop application

  • ./run down
    • Runs docker-compose down (just a shorter way to do it).

Build/rebuild application

  • ./run build
    • Runs docker-compose up --build -d (builds bew image and starts application).
    • Fixes difference of Docker EOL configuration between Windows and Unix/Mac.
    • Runs migrations and seeds.
    • NOTE: In Linux sudo ./run clear must be ran before rebuild to clear ./data folder.

Enter application

  • ./run exec
    • Runs docker exec -ti $APP bash (just a shorter way to do it).

Display list of running containers

  • ./run ps
    • Runs docker ps -a (just a shorter way to do it).

Fix docker files corrupted by Windows EOL standards

  • ./run fix
    • Runs sed -i -e 's/\r$//' $file on list of linux files that are copied from ./config dir.

Clear ./data folder

  • ./run clear OR sudo ./run clear in Linux
    • Removes development database data.

Other commands

Action Inside container
Run migration bin/console doctrine:migrations:migrate
Create fixtures bin/console doctrine:fixtures:load
Run PHPUnit tests bin/phpunit
Run Code Standard tests bin/cs
Run Code autofix bin/cs fix
Run Code Standard in exact directory bin/cs $dir

If DB does not start

  • DB files stored in ./data/mysql and mysql logs in ./data/log.
  • When rebuilding image in Linux, total clearing of these dirs has to be done. Run sudo ./run clear to do it.

Tested on

  • Linux (native docker)
    • App URI: http://localhost:802.
    • Remove ./data folder content before image rebuild.
  • Windows (Docker Toolbox only, not tested on Docker for Windows yet)
    • App URI: http://192.168.99.100:802
    • If default uri does not work, check docker ip with docker-machine ip default command.
    • Use ./run commands instead of standard docker-compose commands since ./run commands solves some multi platform issues and differences between Unix and Windows Docker configurations.
    • There is a known problem in difference of ending of line (EOL) between Linux and Windows. When running with ./run up command list of Linux based files are additionally updated if host os is Windows, in other case nothing will work and build will fail.
    • Use 'Docker Toolbox Terminal', 'Windows PowerShell' or 'GIT bash' to work with application. DO NOT USE Windows 'cmd'. Just don't do it.
    • If you prefer PHP Storm Terminal, configure it to use one of offered above terminals: File > Settings > Tools > Terminal > Shell path > $pathToChoosenTerminal.
    • There should be no additional problems when running app in 'Docker for Windows', but I couldn't test this platform yet so some unknown problems may occur. Be aware of that.

Postman configs

  • Symfony_contacts_api.postman_environment.json - Postman environment configuration. Import it to Postman and token will be automatically renewed on after request to /api/users/token endpoint.
  • Symfony_contacts_api.postman_collection.json - Postman collection with all methods used in this API.