https://github.com/trismegiste/symfony-prelude

Prelude to Symfony : an easy way to start a Symfony app
https://github.com/trismegiste/symfony-prelude

Last synced: about 1 month ago
JSON representation

Prelude to Symfony : an easy way to start a Symfony app

• Host: GitHub
• URL: https://github.com/trismegiste/symfony-prelude
• Owner: Trismegiste
• Created: 2014-08-26T10:27:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-01T16:59:19.000Z (over 10 years ago)
• Last Synced: 2023-07-26T15:47:56.493Z (over 1 year ago)
• Language: PHP
• Size: 164 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Prelude to Symfony [![Build Status](https://travis-ci.org/Trismegiste/symfony-prelude.svg?branch=master)](https://travis-ci.org/Trismegiste/symfony-prelude)

An easy way to start a Symfony app

## What

This small lib does 3 things :

* Provides a fat-free kernel for Symfony 2 with only essential bundles

* Provides an auto-installer script for platform-specific parameters

* Inject a default parameter "developer.name" to customize your configuration when many developers are involved

## Why

Reduce the rate of "But it works on my computer (or my VM) !"

It starts for 3 reasons :

* the lost so many times of the infamous parameters.yml

* the AppKernel class is not [OCP][1]

* customizing parameters automatically between a team

## Example

In the end, the Kernel looks like :

```

use Trismegiste\Prelude\Kernel;

class AppKernel extends Kernel

{

    protected function registerAdditionalBundles()

    {

        return [];

    }

}

```

See through the [phpunit tests][3] or the social network app [iinano][2]

## When

Before you start to mess your AppKernel and parameters.yml. When you don't need

fatty fat bundles like Doctrine or Swiftmailer or ide-validation-less annotations.

## Where

Add this lib to the composer.json of your Symfony project. Add the install script for 

Composer. Rewrite the AppKernel like you can see in [iinano][2]. Remove parameters.yml

(and its reference). Remove Incenteev reference in composer.json.

## Y U NO use Incenteev ?

This lib does not provide a way to prepare a parameters.yml for the preprod server,

for example, so your sysadmin does not get mad when he's installing your app at 1:00 AM.

Only the file for the production server needs to be in gitignore. 

Nonetheless, you can use both in the same project.

[1]: http://en.wikipedia.org/wiki/Open/closed_principle

[2]: https://github.com/Trismegiste/iinano/tree/master/app/AppKernel.php

[3]: https://github.com/Trismegiste/symfony-prelude/blob/master/tests/example/AppKernel.php