open-orchestra/open-orchestra-newsletter-bundle

A bundle which provides a newsletter subscription management for Open Orchestra

v1.2.0 2015-12-29 10:03 UTC

README

A Open Orchestra newsletter bundle

Service Badge
Travis Build Status
CodeClimate (quality) Code Climate
CodeClimate (coverage) Test Coverage
Sension Insight SensioLabsInsight
VersionEye Dependency Status
Latest Stable Version Latest Stable Version
Total Downloads Total Downloads

Description

The open-orchestra-newsletter-bundle provide an easy way to manage a newsletter inside the Open Orchestra project.

It will provide you with :

  • A Front Office block
  • A Back Office integration
  • A way to store the data inside a Mongo database

Usage

Front Office

To use the bundle in a front environment, you will need to activate the bundle and the model :

    // app/AppKernel.php
    new OpenOrchestra\NewsletterBundle\OpenOrchestraNewsletterBundle,
    new OpenOrchestra\NewsletterModelBundle\OpenOrchestraNewsletterModelBundle,

Back Office

To use the bundle in a back envirenment, you will have to add the admin bundle :

    // app/AppKernel.php
    new OpenOrchestra\NewsletterBundle\OpenOrchestraNewsletterBundle,
    new OpenOrchestra\NewsletterModelBundle\OpenOrchestraNewsletterModelBundle,
    new OpenOrchestra\NewsletterAdminBundle\OpenOrchestraNewsletterAdminBundle,

You will also have to import the route for the bundle :

    #app/config/routing.yml
    open_orchestra_newsletter_api:
        resource: "@OpenOrchestraNewsletterAdminBundle/Controller/Api"
        type: annotation
        prefix: /api

    open_orchestra_newsletter_admin:
        resource: "@OpenOrchestraNewsletterAdminBundle/Controller/Admin"
        type: annotation
        prefix: /admin