fabiencrassat/CurriculumVitaeBundle

# Fabien Crassat / Curriculumvitae Bundle

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

[1]: http://symfony.com

[![knpbundles.com](http://knpbundles.com/fabiencrassat/CurriculumVitaeBundle/badge)](http://knpbundles.com/fabiencrassat/CurriculumVitaeBundle) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/2db81c7b-4627-402f-a28e-534397d1188a/big.png)](https://insight.sensiolabs.com/projects/2db81c7b-4627-402f-a28e-534397d1188a)

[![Build Status](https://travis-ci.org/fabiencrassat/CurriculumVitaeBundle.svg?branch=master)](https://travis-ci.org/fabiencrassat/CurriculumVitaeBundle) [![Latest Stable Version](https://poser.pugx.org/fabiencrassat/curriculumvitae/v/stable.svg)](https://packagist.org/packages/fabiencrassat/curriculumvitae) [![Latest Unstable Version](https://poser.pugx.org/fabiencrassat/curriculumvitae/v/unstable.svg)](https://packagist.org/packages/fabiencrassat/curriculumvitae) [![License](https://poser.pugx.org/fabiencrassat/curriculumvitae/license.svg)](https://packagist.org/packages/fabiencrassat/curriculumvitae) [![Total Downloads](https://poser.pugx.org/fabiencrassat/curriculumvitae/downloads.svg)](https://packagist.org/packages/fabiencrassat/curriculumvitae) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fabiencrassat/CurriculumVitaeBundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fabiencrassat/CurriculumVitaeBundle/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/fabiencrassat/CurriculumVitaeBundle/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/fabiencrassat/CurriculumVitaeBundle/?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b63ffa51a3de4399b3dbcfe28f481632)](https://www.codacy.com/app/fabien/CurriculumVitaeBundle?utm_source=github.com&utm_medium=referral&utm_content=fabiencrassat/CurriculumVitaeBundle&utm_campaign=Badge_Grade)
[![Code Climate](https://codeclimate.com/github/fabiencrassat/CurriculumVitaeBundle/badges/gpa.svg)](https://codeclimate.com/github/fabiencrassat/CurriculumVitaeBundle) [![Sonar Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=CurriculumVitaeBundle&metric=alert_status)](https://sonarcloud.io/dashboard?id=CurriculumVitaeBundle) [![Sonar Maintainability](https://sonarcloud.io/api/project_badges/measure?project=CurriculumVitaeBundle&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=CurriculumVitaeBundle)

## Prerequisites

This version of the bundle requires Symfony 4.1+.

## 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:

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

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

``` bash
php composer.phar update fabiencrassat/curriculumvitae
```

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

### Step 2: Enable the bundle without flex

> *In a default Symfony application that uses Symfony Flex, bundles are enabled/disabled automatically for you when installing/removing them, so you don't need to look at or edit this bundles.php file.*

Enable the bundle in the kernel:

``` php
<?php
// config/bundles.php
return [
    // ...
    FabienCrassat\CurriculumVitaeBundle\FabienCrassatCurriculumVitaeBundle::class => ['all' => true],
];
// ...
```

### 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:

``` yaml
# config/routes.yml
fabiencrassat_curriculumvitae:
    resource: "@FabienCrassatCurriculumVitaeBundle/Resources/config/routing.yml"
    prefix:   /cv
```

Or if you prefer XML:

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

## Usage

### Assets installation

``` bash
php bin/console assets:install
```

### View the result

Go to your site and add /cv, for example: `http://localhost:8000/cv`

## [TO_CHECK] Documentation

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

- [Expose your custom Curriculum Vitae Files](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/expose_your_cv.md)
- [Custom your curriculum vitae](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/custom_cv_file.md)
- [Understand the link beetween xml file and twig variables](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/xml_twig_variables.md)
- [Make the curriculum vitae beautiful with OrizoneBoilerplate](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/OrizoneBoilerplateTemplate.md)
- [Add Google Analytics in the OrizoneBoilerplate](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/ConfigureGoogleAnalytics.md)
- [TO_CHECK] [Add an export PDF service](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/export_to_PDF.md)
- [TO_CHECK] [Protect your email and phone number](https://github.com/fabiencrassat/CurriculumVitaeBundle/blob/master/Resources/doc/protect_your_email_and_phone_number.md)