symfony-boilerplate
Docker container to get started with Symfony 2.7 LTS and much more.
What's inside
- PHP 5.6
- Symfony 2.7 LTS
- Nginx
- Node.js / NPM
- MySQL
- Redis
- Elasticsearch
- Blackfire Profiler
- Gulp.js
- Bower
Gulp.js build system
- Browserify (incl. Babel.js ES6 transpiler)
- SASS compilation
- Automatic file watcher
Prerequisites
Install Docker on your system.
- Install instructions for Mac OS X
- Install instructions for Ubuntu Linux
- Install instructions for other platforms
Install Docker Compose on your system.
- Install instructions for all supported systems
Optionally, I suggest that you use docker-machine for managing your Docker hosts.
Get up and running
-
Download or clone this repository
$ git clone https://github.com/b00giZm/symfony-boilerplate.git
-
Copy
app/.env.example
toapp/.env
so Docker (and later Symfony) can use it.$ cd code/symfony-boilerplate; cp app/.env.example app/.env
-
Build your Docker development container container: It will pull a base image from the Docker registry and install all necessary dependencies (This might take a while, depending on your host system).
$ docker-compose build
-
Create and start the main Docker container and attach all linked containers. For your very first run, this will also take a while, because docker-compose first needs to pull the images for all linked containers.
$ docker-compose up -d
-
Install PHP dependencies through Composer, which you installed during step 1.
$ docker-compose run --no-deps web composer update
-
Install Node.js dependencies through npm, which you did also install during the first step.
$ docker-compose run --no-deps web npm install
-
Install frontend components through Bower, which you did also install during the first step.
$ docker-compose run --no-deps web bower install
-
Build all frontend Javascripts and CSS files, contained in the
FrontendBundle
, with Gulp.js and watch file changes for automatic rebuilds.$ docker-compose run --no-deps web gulp
What it does:
- It compiles all SASS stylesheets inside
src/FrontendBundle/Resouerces/public/sass
to CSS. - It compiles Javascripts inside
src/FrontendBundle/Resouerces/public/lib
with Browserify. You can use ES6 and ES7 syntax and features, if you want. Browserify takes care of compiling everyhing to 100% browser compatible Javascript.
- It compiles all SASS stylesheets inside
-
You can then access the app, which should then be running on your docker daemon on HTTP port 8000 (On OS X you can use
docker-machine env dev
to find out the IP address). For convenience, I created alocaldocker.dev
entry in my/etc/hosts
which points to that IP.$ open http://localdocker.dev:8000/app_dev.php
Now go and build something awesome!
Alternative Way
Instead of running steps 5) to 8) as docker-compose
on/off commands, you can run them directly inside the container:
$ docker-compose run --no-deps web bash
root@ee746ce03589:/code/app $ composer update
...
root@ee746ce03589:/code/app $ npm install
...
root@ee746ce03589:/code/app $ bower install
...
root@ee746ce03589:/code/app $ gulp watch
This really is my preferred way, because it involves less typing and it feels more "natural", because you may need to initiate several commands via the CLI on a regular base (creating class skeletons, running database migrations etc.)
Blackfire.io Support
If you want to use the Blackfire profiler, we got you covered as well. Just fill in your Blackfire credentials in app/.env
(after you copied it from app/.env.example
) and you're good to go.
BLACKFIRE_SERVER_ID=YourBlackfireServerID
BLACKFIRE_SERVER_TOKEN=YourBlackfireServerToken
BLACKFIRE_CLIENT_ID=YourBlackfireClientID
BLACKFIRE_CLIENT_TOKEN=YourBlackfireClientToken
BLACKFIRE_LOG_LEVEL=4
Maintainer
Pascal Cremer
- Email: [email protected]
- Twitter: @b00gizm
- Web: http://codenugget.co
License
The MIT License (MIT)
Copyright (c) 2015 Pascal Cremer
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.