Step 1: Checking your Work Environment
Checking your Work Environment¶
Before starting to work on the project, we need to check that everyone has a good working environment. It is very important. The developers tools we have at our disposal today are very different from the ones we had 10 years ago. They have evolved a lot, for the better. It would be a shame to not leverage them. Good tools can get you a long way.
Please, don’t skip this step. Or at least, read the last section about the Symfony CLI.
You need a computer. The good news is that it can run on any popular OS: macOS, Windows, or Linux. Symfony and all the tools we are going to use are compatible with each of these.
I want to move fast with the best options out there. I made opinionated choices for this book.
PostgreSQL is going to be our choice for the database engine.
RabbitMQ is the winner for queues.
You can use Notepad if you want to. I would not recommend it though.
I used to work with Textmate. Not anymore. The comfort of using a “real” IDE is
use statements added and sorted automatically,
jumping from one file to another are a few features that will boost your
I would recommend using Visual Studio Code or PhpStorm. The former is free, the latter is not but has a better integration with Symfony (thanks to the Symfony Support Plugin). It is up to you. I know you want to know which IDE I am using. I am writing this book in Visual Studio Code.
We will switch from the IDE to the command line all the time. You can use your IDE’s built-in terminal, but I prefer to use a real one to have more space.
My last book recommended Subversion for version control. It looks like everybody is using Git now.
On Windows, install Git bash.
Be sure you know how to do the common operations like running
git checkout, …
We will use Docker for services, but I like to have PHP installed on my local computer for performance, stability, and simplicity reasons. Call me old school if you like, but the combination of a local PHP and Docker services is the perfect combo for me.
Use PHP 7.3 if you can, maybe 7.4 depending on when you are reading this book.
Check that the following PHP extensions are installed
or install them now:
sodium. Optionally install
curl as well.
You can check the extensions currently enabled via
We also need
php-fpm if your platform supports it,
php-cgi works as
Managing dependencies is everything nowadays with a Symfony project. Get the latest version of Composer, the package management tool for PHP.
If you are not familiar with Composer, take some time to read about it.
You don’t need to type the full command names:
composer req does the
composer require, use
composer rem instead of
Docker and Docker Compose¶
Services are going to be managed by Docker and Docker Compose. Install them and start Docker. If you are a first time user, get familiar with the tool. Don’t panic though, our usage will be very straightforward. No fancy configurations, no complex setup.
Last, but not least, we will use the
symfony CLI to boost our productivity.
From the local web server it provides, to full Docker integration and
SymfonyCloud support, it will be a great time saver.
To use HTTPS locally, we also need to install a CA to enable TLS support. Run the following command:
$ symfony server:ca:install
Check that your computer has all needed requirements by running the following command:
$ symfony book:check-requirements
If you want to get fancy, you can also run the Symfony proxy.
It is optional but it allows you to get a local domain name ending with
.wip for your project.
When executing a command in a terminal, we will almost always prefix it with
symfony like in
symfony composer instead of just
symfony console instead of
The main reason is that the Symfony CLI automatically sets some environment
variables based on the services running on your machine via Docker. These
environment variables are available for HTTP requests because the
local web server injects them automatically. So, using
symfony on the CLI
ensures that you have the same behavior across the board.
Moreover, the Symfony CLI automatically selects the “best” possible PHP version for the project.
This work, including the code samples, is licensed under a Creative Commons BY-NC-SA 4.0 license.