fabiencrassat/curriculumvitae

Symfony CV bundle

2.0 2018-09-12 13:30 UTC

README

Welcome to the Curriculumvitae bundle - an experimental CV display with Symfony 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 Codacy Badge Code Climate Sonar Quality Gate Sonar Maintainability

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:

{
    "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 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
// 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:

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

Or if you prefer XML:

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

Usage

Assets installation

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: