4xxi Symfony Skeleton is an extension for the official Symfony Skeleton (recommended way for starting new projects using Symfony Flex). It's main idea is to keep simplicity of official Skeleton, while adding must-have dependencies and default configs used in 4xxi for developing majority of the projects. It contains bare Symfony Skeleton with the following additions:
- A minimal set of must-have bundles for production environment
- ORM Pack (Doctrine + Migrations)
- FrameworkExtraBundle (Annotations)
- Sensiolabs SecurityChecker
- A set of bundles and tools that are necessary for development
- Docker Compose and Docker Sync configs optimized for development under Linux and MacOS
- Template for README.md with installation instructions
Creating new project with 4xxi Symfony Skeleton is as easy as running
composer create-project 4xxi/skeleton <project_name>
<project_name> is the directory where you want to setup a new project. New project is ready for development
immediately after this step.
4xxi Symfony Skeleton comes with Docker configuration for local development (includes PHP 7.1, nginx and PostgreSQL) on Linux and MacOS.
- Follow instructions in
project_name-data-syncvolume with the real name of your project. This is needed to keep a unique name for data volume used by Docker Sync for developers working simultaneously on several projects.
- Optional: Add additional PHP extensions to PHP Docker container by following instructions in
- Optional: Add additinal services (like Redis, RabbitMQ, Elasticsearch) in docker-compose.yml.
Projects created by Flex include only the mininum amount of dependencies by default. Most of additional components that were previously a part of Symfony Standard Edition are not installed, so it is up to you to install them if they are really needed.
Most of components could be installed and auto-configured by Flex by running:
composer req <component>
The list of common Components that may be needed for the project:
When you are done with previous steps, update Installation Instructions and remove everything above them in this file.
Everything below is a template for Installation Instructions. It should be updated with the full steps for setting up your project.
- Docker and Docker Compose
- [MacOS Only]: Docker Sync (run
gem install docker-syncto install it)
Application configuration is stored in
cp .env.dist .env to apply the default configuration for local installations.
If you have nginx or apache installed and using 80 port on host system you can either stop them before proceeding or
reconfigure Docker to use another port by changing value of
You can change application environment to
prod by changing
APP_ENV variable in
DB name and credentials could by reconfigured by changing variables with
POSTGRES prefix in
.env file. It is
recommended to restart containers after changing these values (new database will be automatically created on containers
docker-compose up -d
docker-compose exec php bin/console doctrine:migrations:migrate
Place instructions to build frontend here.
Just go to http://localhost
Add application-specific console commands and their description here.
It is recommended to add short aliases for the following frequently used container commands:
docker-compose exec php phpto run php in container
docker-compose exec php composerto run composer
docker-compose exec php bin/consoleto run Symfony CLI commands
docker-compose exec db psqlto run PostgreSQL commands
Fix code style by running PHP CS Fixer:
docker-compose exec php vendor/bin/php-cs-fixer fix
Run PHP Unit Tests:
docker-compose exec php bin/phpunit