Skip to content
nojimage edited this page Apr 13, 2011 · 3 revisions

CakePHP Kickstart plugin

PHP 5.2+, CakePHP 1.3+

CakePHPプロジェクトの初期設定を楽にしたくて作ったプラグインです。

Copyright 2011, php-tips.com (http://php-tips.com)

プラグインのインストール方法

git submodule add してください。

git submodule add -f https://github.com/nojimage/CakePHP-Kickstart-Plugin plguins/kickstart

gitが使えない場合は、Downloadして、pluginsディレクトリに入れてください。

使い方

インストールが完了すると、kickstartコマンドが使えるようになります。

cake/console/cake kickstart

で、プラグイン同梱のkickstart.ymlの内容が実行されます。

設定ファイルを複数指定することも可能です。(設定ファイルの拡張子部分は不要)

cake/console/cake kickstart {config1} {config2}

or

cake/console/cake kickstart run {config1} {config2}

設定ファイルの内容を確認したいだけなら

cake/console/cake kickstart read {config1} {config2}

実行時の確認を飛ばしたい場合は「-y」オプションをつけます。

cake/console/cake kickstart -y {config1} {config2}

設定ファイルについて

YAML形式で記述します。

デフォルトの設定ファイル (kickstart.yml)

exec:
  - chmod -R o+w {$APP}/tmp/

get_simpletest:
  target: vendors

git_submodule:
    repo: -f http://github.com/cakephp/debug_kit.git
    target: plugins/debug_kit

bake: db_config
  • APP/tmp ディレクトリに書き込み権限を与えます。
  • SimpleTestをインストールします。
  • DebugKitをインストールします。
  • bakeコマンドでDBの設定を行います。

設定ファイルの読み込み場所について

  • /app/config/*.yml
  • /*.yml

の順で読み込みます。

cake/console/cake kickstart plugin_name.kickstart

のようにすれば、plugin_nameというプラグインのconfig配下にあるkickstart.ymlを読み込みます。

kickstart.sh

CakeShellであるkickstartとは別に、"kickstart.sh"というbashスクリプトを同梱しています。 このスクリプトは、プロジェクトディレクトリを作成し、cakephpの取得とkickstartプラグインのインストールを行います。

kickstart.sh のインストール方法

ワークスペースへkickstart.shをコピーしてください。

cp kickstart.sh {YOUR_WORKSPACE}

使い方

./kickstart.sh someproject_name init

上記コマンドで、someproject_nameディレクトリを作成し、CakePHPの取得、Kickstartプラグインのインストールまで行います。

何で作ったの

  • 何となく
  • CakePHPの初期設定はだいたい共通なのでワンコマンドでできるといいよね。
  • プラグインのレポジトリを忘れがちなので、プラグイン名ぐらい覚えておけばインストールできると嬉しいよね。

今後の予定

サンプルの設定ファイルをもうちょっと整備します。

アイディア、ご要望とかありましたら @nojimage までご連絡ください。

LISENCE

Licensed under The MIT License. Redistributions of files must retain the above copyright notice.

Copyright 2011, php-tips.com (http://php-tips.com)

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.

Clone this wiki locally
You can’t perform that action at this time.