Skip to content

Simplify the setup article #8855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Simplify the setup article #8855

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57d7b1a
Simplify the setup article
javiereguiluz Dec 8, 2017
ef015ab
-
javiereguiluz Dec 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 8 additions & 31 deletions setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ First, move into your new project and install the server:

.. code-block:: terminal

cd my-project
composer require server --dev
$ cd my-project
$ composer require server --dev

To start the server, run:

Expand All @@ -62,6 +62,12 @@ Open your browser and navigate to ``http://localhost:8000/``. If everything is w
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 :doc:`Symfony Requirements Checker </reference/requirements>`
tool to make sure your system is set up.

.. tip::

If you're using a VM, you may need to tell the server to bind to all IP addresses:
Expand Down Expand Up @@ -89,35 +95,6 @@ Your project already has a sensible ``.gitignore`` file. And as you install more
packages, a system called :ref:`Flex <flex-quick-intro>` will add more lines to that
file when needed.

Troubleshooting: The Requirements Checker
-----------------------------------------

If you're having any problems running Symfony, your system may be missing some
`technical requirements`_. Symfony has a "Requirements Checker" tool that you
can use to easily make sure your system is set up. First, move into your project
directory and install it:

.. code-block:: terminal

$ composer require req-checker

The ``req-checker`` utility adds two PHP scripts to your application:
``vendor/bin/requirements-checker`` and ``public/check.php``. Run the first one
from your terminal:

.. code-block:: terminal

php vendor/bin/requirements-checker

This will check your CLI environment. Run the second one from a browser (e.g.
``http://localhost:8000/check.php``) to check your web server environment.

Once you've fixed any issues, uninstall the requirements checker:

.. code-block:: terminal

$ composer remove req-checker

.. _install-existing-app:

Setting up an Existing Symfony Project
Expand Down