tseho/symfony-api-skeleton

v2.0.0 2021-11-29 22:13 UTC

Requires

• php: ^8.0.13
• ext-ctype: *
• ext-iconv: *
• api-platform/core: ^2.6
• doctrine/annotations: ^1.13
• lexik/jwt-authentication-bundle: ^2.14
• nelmio/cors-bundle: ^2.1
• symfony/console: 5.4.*
• symfony/dotenv: 5.4.*
• symfony/flex: ^1.3.1
• symfony/framework-bundle: 5.4.*
• symfony/monolog-bundle: ^3.7
• symfony/runtime: 5.4.*
• symfony/yaml: 5.4.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.2
• phpstan/phpstan: ^1.1
• phpunit/phpunit: ^9.5
• symfony/asset: 5.4.*
• symfony/phpunit-bridge: ^5.3
• symfony/twig-bundle: 5.4.*
• vimeo/psalm: ^4.12

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *

MIT

README

How to use the skeleton

composer create-project --ignore-platform-reqs tseho/symfony-api-skeleton [directory]

Production

build the docker image:

DOCKER_IMAGE_NAME=foo DOCKER_IMAGE_VERSION=latest make docker-image

launch apache+php on port 8080:

docker run -d -p 127.0.0.1:8080:8080/tcp $DOCKER_IMAGE_NAME:$DOCKER_IMAGE_VERSION

Development

Start the project in 3 steps

1. Create your local .env file

make .env

1. Edit the values in .env, if necessary
2. Start the development environment:

make up

Useful commands

make up # build & start the containers
make down # stop the containers
make destroy # remove all containers, all volumes, all docker images

make tests # launch all the tests

docker-compose run --rm php bin/console [cmd] # execute a symfony command
docker-compose run --rm composer [cmd] # execute a composer command