|
|
@@ -1,148 +1,6 @@
|
|
1
|
|
-Symfony Standard Edition
|
|
2
|
|
-========================
|
|
|
1
|
+# Muzi.ch
|
|
|
2
|
+recently open sourced:
|
|
3
|
3
|
|
|
4
|
|
-Welcome to the Symfony Standard Edition - a fully-functional Symfony2
|
|
5
|
|
-application that you can use as the skeleton for your new app. If you want
|
|
6
|
|
-to learn more about the features included, see the "What's Inside?" section.
|
|
7
|
|
-
|
|
8
|
|
-This document contains information on how to download and start using Symfony.
|
|
9
|
|
-For a more detailed explanation, see the
|
|
10
|
|
-[Installation chapter](http://symfony.com/doc/current/book/installation.html)
|
|
11
|
|
-of the Symfony Documentation.
|
|
12
|
|
-
|
|
13
|
|
-1) Download the Standard Edition
|
|
14
|
|
---------------------------------
|
|
15
|
|
-
|
|
16
|
|
-If you've already downloaded the standard edition, and unpacked it somewhere
|
|
17
|
|
-within your web root directory, then move on to the "Installation" section.
|
|
18
|
|
-
|
|
19
|
|
-To download the standard edition, you have two options:
|
|
20
|
|
-
|
|
21
|
|
-### Download an archive file (*recommended*)
|
|
22
|
|
-
|
|
23
|
|
-The easiest way to get started is to download an archive of the standard edition
|
|
24
|
|
-(http://symfony.com/download). Unpack it somewhere under your web server root
|
|
25
|
|
-directory and you're done. The web root is wherever your web server (e.g. Apache)
|
|
26
|
|
-looks when you access `http://localhost` in a browser.
|
|
27
|
|
-
|
|
28
|
|
-### Clone the git Repository
|
|
29
|
|
-
|
|
30
|
|
-We highly recommend that you download the packaged version of this distribution.
|
|
31
|
|
-But if you still want to use Git, you are on your own.
|
|
32
|
|
-
|
|
33
|
|
-Run the following commands:
|
|
34
|
|
-
|
|
35
|
|
- git clone http://github.com/symfony/symfony-standard.git
|
|
36
|
|
- cd symfony-standard
|
|
37
|
|
- rm -rf .git
|
|
38
|
|
-
|
|
39
|
|
-2) Installation
|
|
40
|
|
----------------
|
|
41
|
|
-
|
|
42
|
|
-Once you've downloaded the standard edition, installation is easy, and basically
|
|
43
|
|
-involves making sure your system is ready for Symfony.
|
|
44
|
|
-
|
|
45
|
|
-### a) Check your System Configuration
|
|
46
|
|
-
|
|
47
|
|
-Before you begin, make sure that your local system is properly configured
|
|
48
|
|
-for Symfony. To do this, execute the following:
|
|
49
|
|
-
|
|
50
|
|
- php app/check.php
|
|
51
|
|
-
|
|
52
|
|
-If you get any warnings or recommendations, fix these now before moving on.
|
|
53
|
|
-
|
|
54
|
|
-### b) Install the Vendor Libraries
|
|
55
|
|
-
|
|
56
|
|
-If you downloaded the archive "without vendors" or installed via git, then
|
|
57
|
|
-you need to download all of the necessary vendor libraries. If you're not
|
|
58
|
|
-sure if you need to do this, check to see if you have a ``vendor/`` directory.
|
|
59
|
|
-If you don't, or if that directory is empty, run the following:
|
|
60
|
|
-
|
|
61
|
|
- php bin/vendors install
|
|
62
|
|
-
|
|
63
|
|
-Note that you **must** have git installed and be able to execute the `git`
|
|
64
|
|
-command to execute this script. If you don't have git available, either install
|
|
65
|
|
-it or download Symfony with the vendor libraries already included.
|
|
66
|
|
-
|
|
67
|
|
-### c) Access the Application via the Browser
|
|
68
|
|
-
|
|
69
|
|
-Congratulations! You're now ready to use Symfony. If you've unzipped Symfony
|
|
70
|
|
-in the web root of your computer, then you should be able to access the
|
|
71
|
|
-web version of the Symfony requirements check via:
|
|
72
|
|
-
|
|
73
|
|
- http://localhost/Symfony/web/config.php
|
|
74
|
|
-
|
|
75
|
|
-If everything looks good, click the "Bypass configuration and go to the Welcome page"
|
|
76
|
|
-link to load up your first Symfony page.
|
|
77
|
|
-
|
|
78
|
|
-You can also use a web-based configurator by clicking on the "Configure your
|
|
79
|
|
-Symfony Application online" link of the ``config.php`` page.
|
|
80
|
|
-
|
|
81
|
|
-To see a real-live Symfony page in action, access the following page:
|
|
82
|
|
-
|
|
83
|
|
- web/app_dev.php/demo/hello/Fabien
|
|
84
|
|
-
|
|
85
|
|
-3) Learn about Symfony!
|
|
86
|
|
------------------------
|
|
87
|
|
-
|
|
88
|
|
-This distribution is meant to be the starting point for your application,
|
|
89
|
|
-but it also contains some sample code that you can learn from and play with.
|
|
90
|
|
-
|
|
91
|
|
-A great way to start learning Symfony is via the [Quick Tour](http://symfony.com/doc/current/quick_tour/the_big_picture.html),
|
|
92
|
|
-which will take you through all the basic features of Symfony2 and the test
|
|
93
|
|
-pages that are available in the standard edition.
|
|
94
|
|
-
|
|
95
|
|
-Once you're feeling good, you can move onto reading the official
|
|
96
|
|
-[Symfony2 book](http://symfony.com/doc/current/).
|
|
97
|
|
-
|
|
98
|
|
-Using this Edition as the Base of your Application
|
|
99
|
|
---------------------------------------------------
|
|
100
|
|
-
|
|
101
|
|
-Since the standard edition is fully-configured and comes with some examples,
|
|
102
|
|
-you'll need to make a few changes before using it to build your application.
|
|
103
|
|
-
|
|
104
|
|
-The distribution is configured with the following defaults:
|
|
105
|
|
-
|
|
106
|
|
-* Twig is the only configured template engine;
|
|
107
|
|
-* Doctrine ORM/DBAL is configured;
|
|
108
|
|
-* Swiftmailer is configured;
|
|
109
|
|
-* Annotations for everything are enabled.
|
|
110
|
|
-
|
|
111
|
|
-A default bundle, ``AcmeDemoBundle``, shows you Symfony2 in action. After
|
|
112
|
|
-playing with it, you can remove it by following these steps:
|
|
113
|
|
-
|
|
114
|
|
-* delete the ``src/Acme`` directory;
|
|
115
|
|
-* remove the routing entries referencing AcmeBundle in ``app/config/routing_dev.yml``;
|
|
116
|
|
-* remove the AcmeBundle from the registered bundles in ``app/AppKernel.php``;
|
|
117
|
|
-
|
|
118
|
|
-
|
|
119
|
|
-What's inside?
|
|
120
|
|
----------------
|
|
121
|
|
-The Symfony Standard Edition comes pre-configured with the following bundles:
|
|
122
|
|
-
|
|
123
|
|
-* **FrameworkBundle** - The core Symfony framework bundle
|
|
124
|
|
-* **SensioFrameworkExtraBundle** - Adds several enhancements, including template
|
|
125
|
|
- and routing annotation capability ([documentation](http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html))
|
|
126
|
|
-* **DoctrineBundle** - Adds support for the Doctrine ORM
|
|
127
|
|
- ([documentation](http://symfony.com/doc/current/book/doctrine.html))
|
|
128
|
|
-* **TwigBundle** - Adds support for the Twig templating engine
|
|
129
|
|
- ([documentation](http://symfony.com/doc/current/book/templating.html))
|
|
130
|
|
-* **SecurityBundle** - Adds security by integrating Symfony's security component
|
|
131
|
|
- ([documentation](http://symfony.com/doc/current/book/security.html))
|
|
132
|
|
-* **SwiftmailerBundle** - Adds support for Swiftmailer, a library for sending emails
|
|
133
|
|
- ([documentation](http://symfony.com/doc/2.0/cookbook/email.html))
|
|
134
|
|
-* **MonologBundle** - Adds support for Monolog, a logging library
|
|
135
|
|
- ([documentation](http://symfony.com/doc/2.0/cookbook/logging/monolog.html))
|
|
136
|
|
-* **AsseticBundle** - Adds support for Assetic, an asset processing library
|
|
137
|
|
- ([documentation](http://symfony.com/doc/2.0/cookbook/assetic/asset_management.html))
|
|
138
|
|
-* **JMSSecurityExtraBundle** - Allows security to be added via annotations
|
|
139
|
|
- ([documentation](http://symfony.com/doc/current/bundles/JMSSecurityExtraBundle/index.html))
|
|
140
|
|
-* **WebProfilerBundle** (in dev/test env) - Adds profiling functionality and
|
|
141
|
|
- the web debug toolbar
|
|
142
|
|
-* **SensioDistributionBundle** (in dev/test env) - Adds functionality for configuring
|
|
143
|
|
- and working with Symfony distributions
|
|
144
|
|
-* **SensioGeneratorBundle** (in dev/test env) - Adds code generation capabilities
|
|
145
|
|
- ([documentation](http://symfony.com/doc/current/bundles/SensioGeneratorBundle/index.html))
|
|
146
|
|
-* **AcmeDemoBundle** (in dev/test env) - A demo bundle with some example code
|
|
147
|
|
-
|
|
148
|
|
-Enjoy!
|
|
|
4
|
+* Write a howto for installation
|
|
|
5
|
+* Choose a licence
|
|
|
6
|
+* list bugs and possible enhancements
|
