You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

Installing & Setting up the Symfony Framework

4.4 version

Installing & Setting up the Symfony Framework

Screencast

Do you prefer video tutorials? Check out the Stellar Development with Symfony screencast series.

Installing Symfony

Before creating your first Symfony application, make sure to meet the following requirements:

  • Your server has PHP 7.1 or higher installed (and these PHP extensions which are installed and enabled by default by PHP);
  • You have installed Composer, which is used to install PHP packages;
  • You have installed the Symfony local web server, which provides all the tools you need to develop your application locally.

Once these requirements are installed, open your terminal and run any of these commands to create the Symfony application:

1
2
3
4
5
# run this if you are building a traditional web application
$ symfony new --full my_project

# run this if you are building a microservice, console application or API
$ symfony new my-project

The only difference between these two commands is the number of packages installed. The --full option installs all the packages that you usually need to build web apps. Therefore, the installation size will be much bigger.

Both commands will create a new my-project/ directory, download some dependencies into it and even generate the basic directories and files you'll need to get started. In other words, your new app is ready!

If you can't use the symfony command provided by the Symfony local web server, use the alternative installation commands based on Composer and displayed on the Symfony download page.

Running your Symfony Application

On production, you should use a web server like Nginx or Apache (see configuring a web server to run Symfony). But for development, it's more convenient to use the Symfony Local Web Server installed earlier.

This local server provides support for HTTP/2, TLS/SSL, automatic generation of security certificates and many other features. It works with any PHP application, not only Symfony projects, so it's a very useful development tool.

Open your terminal, move into your new project directory and start the local web server as follows:

1
2
$ cd my-project/
$ symfony server:start

Open your browser and navigate to http://localhost:8000/. If everything is working, you'll see a welcome page. Later, when you are finished working, stop the server by pressing Ctrl+C from your terminal.

Tip

If you're having any problems running Symfony, your system may be missing some technical requirements. Use the Symfony Requirements Checker tool to make sure your system is set up.

Note

If you want to use a virtual machine (VM) with Vagrant, check out Homestead.

Storing your Project in git

Storing your project in services like GitHub, GitLab and Bitbucket works like with any other code project! Init a new repository with Git and you are ready to push to your remote:

1
2
3
$ git init
$ git add .
$ git commit -m "Initial commit"

Your project already has a sensible .gitignore file. And as you install more packages, a system called Flex will add more lines to that file when needed.

Setting up an Existing Symfony Project

If you're working on an existing Symfony application, you only need to get the project code and install the dependencies with Composer. Assuming your team uses Git, setup your project with the following commands:

1
2
3
4
5
6
7
# clone the project to download its contents
$ cd projects/
$ git clone ...

# make Composer install the project's dependencies into vendor/
$ cd my-project/
$ composer install

You'll probably also need to customize your .env and do a few other project-specific tasks (e.g. creating database schema). When working on a existing Symfony app for the first time, it may be useful to run this command which displays information about the app:

1
$ php bin/console about

The Symfony Demo application

The Symfony Demo Application is a fully-functional application that shows the recommended way to develop Symfony applications. It's a great learning tool for Symfony newcomers and its code contains tons of comments and helpful notes.

To check out its code and install it locally, see symfony/symfony-demo.

Start Coding!

With setup behind you, it's time to Create your first page in Symfony.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.