vince/sandbox

This package is abandoned and no longer maintained. No replacement package was suggested.

The "Vince Cms" sandbox

This package is not auto-updated.

Last update: 2019-02-20 17:35:57 UTC


README

THIS PROJECT IS NOT MAINTAINED ANYMORE !

Sandbox for VinceCms

Total Downloads Latest Stable Version Build Status SensioLabsInsight Coverage Status

Installation

Install Composer and run the following command:

php composer.phar create-project vince/sandbox path/ -s dev

Configuration

Run the following command to launch ElasticSearch:

vendor/elasticsearch/binaries/bin/elasticsearch -f

Once you've created your database, run the following command to build database with default fixtures:

php app/console project:reset

This command also publish assets for different project environments.

You should index your articles to ElasticSearch:

php app/console fos:elastica:populate

Deploy

This sandbox has already been capified. Before your first deploy, you must update configuration file:

# File: app/config/deploy/development.rb
...
set :domain, "1.2.3.4"
set :user,   "user"

Note: it's not recommended to set user password, prefer use RSA key.

You can now configure your server through the following command:

cap production deploy:setup

Then deploy with the following command:

cap production deploy

On deploy, capifony will ask you which version you want to deploy, by default the last tag.

Developers

For local use, you should catch emails through mailcatcher. You need to update your parameters.yml file as following:

parameters:
    ...
    mailer_host: localhost:1025

todo-vince Sandbox

  • Initialization command
  • Google Analytics tracking code (bundle configuration)
  • Default theme
  • Mail theme
  • Behat
  • Update travis configuration
  • Documentation (README + PHPDoc + GitHub pages)

Documentation

Installation

  • Install with composer
  • Create database
  • Run php app/console project:reset
  • [ ] Access to admin (url, login, password)

Configuration

  • Update config.yml: domain, sitename, tracking_code, no_reply, contact

How to

Developers

  • Fixtures
    • Create fixtures in YML
    • Create templates (& areas)
    • Create articles (& contents & metas)
    • Create menus (=> article or url, parent, children)
    • Create blocks
  • Deploy (Capifony)
  • Inject objects in template (listeners)
  • Process forms (processors)
  • Advanced
    • Override entities
    • Override controllers
    • Override admin
    • Catch mail on dev (MailCatcher)
    • PHPDoc

Designers

  • Create template
    • Create twig file
    • Twig helpers
      • vince configuration
      • render_metas
      • render_meta
      • render_menu
      • render_block
      • localizeddate
  • Assetic
    • Bootstrap
    • Ladda
    • Autosize
    • YUI compressor