fabiencrassat/curriculumvitae

Symfony CV bundle

0.6 2014-11-08 23:58 UTC

README

Welcome to the Curriculumvitae bundle - an experimental CV display with Symfony2 application that you can use to display your curriculum vitae.

knpbundles.com SensioLabsInsight

Build Status Latest Stable Version Latest Unstable Version License Total Downloads Scrutinizer Code Quality Code Coverage

Prerequisites

This version of the bundle requires Symfony 2.4.1+.

Translations

If you wish to use default texts provided in this bundle, you have to make sure you have translator enabled in your config.

# app/config/config.yml

framework:
    translator: ~

For more information about translations, check Symfony documentation.

Installation

  1. Install Curriculumvitae Bundle
  2. Enable the bundle
  3. Import the routing file

Step 1: Install Curriculumvitae Bundle

Add the following dependency to your composer.json file:

{
    "require": {
        "_some_packages": "...",
        "fabiencrassat/curriculumvitae": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update fabiencrassat/curriculumvitae

Composer will install the bundle to your project's vendor/fabiencrassat directory.

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FabienCrassat\CurriculumVitaeBundle\FabienCrassatCurriculumVitaeBundle(),
    );
}
// ...
?>

Step 3: Import FabienCrassat CurriculumVitae Bundle routing

Finally, now that you have activated and configured the bundle, all that is left to do is import the routing file.

In YAML:

# app/config/routing.yml
fabiencrassat_curriculumvitae:
    resource: "@FabienCrassatCurriculumVitaeBundle/Resources/config/routing.yml"
    prefix:   /cv

Or if you prefer XML:

<!-- app/config/routing.xml -->
<import resource="@FabienCrassatCurriculumVitaeBundle/Resources/config/routing.xml" prefix="/cv" />

Usage

Assets installation

$ php app/console assets:install

View the result

Go to your site and add /cv, for example: http://localhost/app_dev.php/cv

Documentation

The bulk of the documentation is stored in the Resources/doc/ directory in this bundle: