README

Project ready to deploy, based on the top of Symfony2 and Sonata Project using Th3Mouk extends bundle.

This project aims to simplify the use of Sonata CMS for developers and future users, trying to not alter the original flexibility, and to give them new basic tools.

Installation

Via Composer

Go into your project's folder :

# Example of user's folder
cd ~/projects

Now tell composer to create and download the project:

$ composer create-project th3mouk/cms-starter my_project_name

Composer will install the project and his dependencies.

The project is now deployed in your folder.

Load Fixtures Datas

The project comes with lots of examples fixtures.

This allows to create user, medias, CMS pages, menu items... and many mores.

To adapt this part to your needs you need referer to the following docs:

• DoctrineFixturesBundle
• How to Create a Console Command

The project will not work without executing this command:

php bin/load_data.php

She allows to reflate all the commands present in the file bin/load_data.php

It's also a way to reload your new datas during phases of development.

Finally

That's all folks !

Your project is now fully installed, and functional.

Update CMSStarter

Only one solution is advised to easily update your project: cherry pick

You need to have a remote on your subversion, directly on this repository. Call it maybe (=D), updates and checkout the master branch.

When there is new releases you have the choice : merging or cherry picking into your project.

Configuration

CKEditor

A default configuration with SonataMedia exists in app/config/config.yml, delete it to implement your own, like with FMElfinderBundle integration.

Extend me

Bundle pack

A fix, a feature, typo or missing docs ?

Submit it and be part of CMS Starter !

This project use:

• CMSCoreBundle (The core provide default configuration of CMS and basic dependencies)
• CMSPageBundle (Extend of SonataPageBundle)
• Id4vMenuBundle (Manageable and customizable menu)

Install Grunt modules

You must be familiar with Grunt to add others modules and tasks.

npm install

Bower

You must be familiar with Bower to add dependencies

bower install

Style

At each modification of the LESS/CSS, you need to re-compile starter.min.css file.

Run:

grunt css

This command make 2 tasks in one: (compression and minimization)

Beware

This operation overwritte the web/css/style.css file.

You need to modify Gruntfile.js or LESS files in app/Resources/public/less to adapt behaviors on your need.

LiveReload

You can also run this task and use LiveReload for reload browser pages instantly at each save of LESS file.

grunt watch

This task run in background and recompile starter.min.css each time you save a modification of a LESS file, in this folder app/Resources/public/less/. Under the hood grunt watch launch grunt css.

Javascripts

In the same way, this command

grunt js

Allow to compress and minimize all the javascripts in starter.min.js.

Tweaks

All modifications, and certainly addition of stylesheets and scripts, can be made in the Gruntfile.js.