README

A simple Bash script for automated preparation of Composer based applications (i.e. ZendFramework apps).

Installation

General installation procedure

Only caq.sh(https://raw.github.com/websafe/caq/master/caq.sh) is really required, download it into a location available via PATH and make it executable. That's all.

Install using PHP

php -r \
    "copy('https://raw.github.com/websafe/caq/master/caq.sh', '/usr/bin/caq');"
chmod +x /usr/bin/caq

Install using GNU Wget

wget -nc \
    https://raw.github.com/websafe/caq/master/caq.sh \
    -O /usr/bin/caq
chmod +x /usr/bin/caq

-ns stands for --no-clobber:

-nc, --no-clobber skip downloads that would download to existing files (overwriting them).

Install using Lynx

lynx -dump \
    https://raw.github.com/websafe/caq/master/caq.sh \
    > /usr/bin/caq
chmod +x /usr/bin/caq

Usage

Basic usage

Basic usage is:

caq <vendor>/<project> <profile>

Examples

Example 1. A ZendSkeletonApplication based project with ZendFramework

This will create a project located in directory ./my-example-1 based on ZendSkeletonApplication with ZendFramework installed as a Composer package in ./vendor/zendframework:

caq myvendor/my-example-1 zf2-app

Example 2. An empty project with ZendFramework libraries

This will create a project located in directory ./my-example-2 based on nothing (no skeleton application) with ZendFramework installed as a Composer package in ./vendor/zendframework, in other words, a project with the pure framework, no application:

caq myvendor/my-example-2 zf2

Example 3. A Symfony Standard Edition based project.

This will create a project located in directory ./my-example-3 based on the Symfony Standard Edition skeleton:

caq myvendor/my-example-3 symfony-standard

Example 4. An empty project with Symfony libraries

This will create a project located in directory ./my-example-4 based on nothing (no skeleton application) with Symfony installed as Composer package in ./vendor/symfony:

caq myvendor/my-example-4 symfony

Example 5. A WordPress based project

This will create a project located in directory ./my-example-5 based on WordPress:

caq myvendor/my-example-5 wordpress

Example 6. A ZendSkeletonApplication based project with ZendFramework libraries and ZfcUser module

This will create a project located in directory ./my-example-6 based on ZendSkeletonApplication with ZendFramework installed as a Composer package in ./vendor/zendframework/zendframework and ZfcUser module installed as a Composer package in ./vendor/zf-commons/zfc-user:

caq myvendor/my-example-6 zf2-app-zfc-user

Example 7. An empty project with Twig libraries.

This will create an empty project located in directory ./my-example-7 with Twig libraries installed as a Composer package in ./vendor/twig/twig:

caq myvendor/my-example-7 twig

Example 8. A Kohana PHP Framework based project.

This will create a Kohana PHP Framework based project located in directory ./my-example-8:

caq myvendor/my-example-8 kohana

Example 9. A Drupal based project.

This will create a Drupal based project located in directory ./my-example-9:

caq myvendor/my-example-9 drupal

Example 10. A CodeIgniter based project.

This will create a CodeIgniter based project located in directory ./my-example-10:

caq myvendor/my-example-10 codeigniter

Example 11. A Joomla based project.

This will create a Joomla based project located in directory ./my-example-11:

caq myvendor/my-example-11 joomla

Contributing

Start using caq!
Report issues
Request features
Read 14 Ways to Contribute to Open Source without Being a Programming Genius

Requirements

TODO

create documentation describing [Profiles]
classmap_generator after installing deps
User configs profiles in ~/.caq/
User templates for faster creation of projects (stored in ~/.caq/templates)
Plugins
Profiles testsuite
travis
Windows/Cygwin compatible

How caq works

The basic procedure

THIS SECTION IS INCOMPLETE

If there is a [Skeleton Application] URI configured, try to clone this repo into projects root directory. If no skeleton URI was configured, skip to next step.
Install Composer in vendor/bin of projects root directory.
Selfupdate the previously installed Composer
Install all packages (Composer packages) configured for the current Profile. If no packages were defined, skip to next step.

Basically, when You don't define a Skeleton Application URI (SA) and don't define any packages (PKG/PKGD) You'll end up with an empty project, containing:

empty
|-- .git
|-- vendor
|   |-- bin
|   |   `-- composer.phar
|   |-- composer
|   |   |-- ClassLoader.php
|   |   |-- autoload_classmap.php
|   |   |-- autoload_namespaces.php
|   |   `-- autoload_real.php
|   `-- autoload.php
|-- LICENSE
|-- README.md
`-- composer.json

License

caq - Composed Application Quickstarter (https://github.com/websafe/caq/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

websafe / caq

Maintainers

Details