Permalink
Browse files

bug #3827 Update 'How to Create and store a Symfony2 Project in Git' …

…(nicwortel)

This PR was merged into the 2.3 branch.

Discussion
----------

Update 'How to Create and store a Symfony2 Project in Git'

This pull request updates the cookbook article [How to Create and store a Symfony2 Project in Git](http://symfony.com/doc/current/cookbook/workflow/new_project_git.html#initial-project-setup).

It started with [this question (and its answer by Wouter J) on Stack Overflow](http://stackoverflow.com/q/23437768/1001110).

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all (or 2.3+)
| Fixed tickets | n/a

Commits
-------

3f3d886 Update the tip about the global .gitignore
1baf7e0 Remove dash
6fd5e52 Small improvement
d9f72f9 Some refactoring of the article
083c1f5 Replace static version constraint (2.4.4)
32cee81 Small change in the wording
311f14b Replace numbered list items with #
6a19628 Indent the tip to be on the same level as the list item
34d61eb Update the complete 'Initial Project Setup' paragraph
011e0f0 Update .gitignore example
  • Loading branch information...
weaverryan committed May 27, 2014
2 parents 3792fee + 3f3d886 commit 0cb9c3bc3fb6d17a8fafd778abf8dc6981fc550d
Showing with 27 additions and 26 deletions.
  1. +27 −26 cookbook/workflow/new_project_git.rst
@@ -20,51 +20,51 @@ Initial Project Setup
To get started, you'll need to download Symfony and initialize your local
git repository:
1. Download the `Symfony2 Standard Edition`_ without vendors.
#. Download the `Symfony2 Standard Edition`_ using Composer:
2. Unzip/untar the distribution. It will create a folder called Symfony with
your new project structure, config files, etc. Rename it to whatever you like.
3. Create a new file called ``.gitignore`` at the root of your new project
(e.g. next to the ``composer.json`` file) and paste the following into it. Files
matching these patterns will be ignored by Git:
.. code-block:: text
/web/bundles/
/app/bootstrap*
/app/cache/*
/app/logs/*
/vendor/
/app/config/parameters.yml
.. code-block:: bash
.. tip::
$ php composer.phar create-project symfony/framework-standard-edition path/ ~2.3
You may also want to create a .gitignore file that can be used system-wide,
in which case, you can find more information here: `Github .gitignore`_
This way you can exclude files/folders often used by your IDE for all of your projects.
Composer will now download the Standard Distribution along with all of the
required vendor libraries. For more information about downloading Symfony using
Composer, see `Installing Symfony using Composer`_.
4. Initialize your Git repository:
#. Initialize your Git repository:
.. code-block:: bash
$ git init
5. Add all of the initial files to Git:
#. Add all of the initial files to Git:
.. code-block:: bash
$ git add .
6. Create an initial commit with your started project:
.. tip::
As you might have noticed, not all files that were downloaded by Composer in step 1,
have been staged for commit by Git. Certain files and folders, such as the project's
dependencies (which are managed by Composer), ``parameters.yml`` (which contains sensitive
information such as database credentials), log and cache files and dumped assets (which are
created automatically by your project), should not be committed in Git. To help you prevent
committing those files and folders by accident, the Standard Distribution comes with a
file called ``.gitignore``, which contains a list of files and folders that Git should
ignore.
.. tip::
You may also want to create a ``.gitignore`` file that can be used system-wide.
This allows you to exclude files/folders for all your projects that are created by
your IDE or operating system. For details, see `Github .gitignore`_.
#. Create an initial commit with your started project:
.. code-block:: bash
$ git commit -m "Initial commit"
7. Finally, download all of the third-party vendor libraries by
executing Composer. For details, see :ref:`installation-updating-vendors`.
At this point, you have a fully-functional Symfony2 project that's correctly
committed to Git. You can immediately begin development, committing the new
changes to your Git repository.
@@ -111,6 +111,7 @@ manage this is `Gitolite`_.
.. _`Git`: http://git-scm.com/
.. _`Symfony2 Standard Edition`: http://symfony.com/download
.. _`Installing Symfony using Composer`: http://symfony.com/doc/current/book/installation.html#option-1-composer
.. _`git submodules`: http://git-scm.com/book/en/Git-Tools-Submodules
.. _`GitHub`: https://github.com/
.. _`barebones repository`: http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository

0 comments on commit 0cb9c3b

Please sign in to comment.