Skip to content

Latest commit

 

History

History
112 lines (82 loc) · 4.59 KB

README.md

File metadata and controls

112 lines (82 loc) · 4.59 KB
Raw

Pretty Cake [Alpha]: A Cake Bake Console Template for CakePHP

A personal template theme for baking custom views, using Twitter Bootstrap to perform user interface.

Requirements

This template theme is for Cake Bake Utility of CakePHP 2.x (for now, only testing on 2.5.6).

Note: You should include those Cascading Style Sheets (*.css) and JavaScript (*.js) resources in your layout(s).

Installation

GIT submodule

Use this option if you wanna get the up-to-date content.

In your app directory, type:

git submodule add https://github.com/nelson6e65/pretty_cake.git Console/Templates/pretty_cake
git submodule init
git submodule update

#####Note: You can use another name instead of pretty_cake 😉. For example, if you wanna use just bootstrap, the run insted:

git submodule add https://github.com/nelson6e65/pretty_cake.git Console/Templates/bootstrap
git submodule init
git submodule update

Manual

  • Download lastest zip or release.
  • Decompress it. You will get a folder.
  • Rename the resulting folder to pretty_cake.
  • Move it under your templates directory (app/Console/Templates/{here}).

#####Note: You can use another name instead of pretty_cake. For example, if you wanna use just bootstrap, then rename folder to bootstrap. 😉

Usage

Once you installed, you are able to bake a Pretty Cake. 😃

You just need to pass -t (--theme) argument to cake bake:

$ cake bake [subcommand] [-h] [-v] [-q] [-c default] [-t]

On Windows, you can run:

$ cd path/to/cakephp/app
$ .\Console\cake bake -t "pretty_cake"

If you don't pass --theme argument (or you typed a wrong template name), bake will ask you (at end) which template to use:

---------------------------------------------------------------
You have more than one set of templates installed.
Please choose the template set you wish to use:
---------------------------------------------------------------
1. pretty_cake
2. default
Which bake theme would you like to use? (1/2)
[1] >

Then, choose pretty_cake (1 in this example) and press Enter to continue. 😆

#####Note: If you changed the default theme name (pretty_cake), you must run $ .\Console\cake bake -t "{theme_name}" command instead (or select {theme_name} when bake ask you), where {theme_name} means your personalized name 😉.

Example: For bootstrap theme name, you should run instead:

$ .\Console\cake bake -t "bootstrap"

Instructions FAQ

What means path/to/cakephp/app?

[See below].

What means app directory?

Is de root path of your application. That is, by default, the app subdirectory of your CakePHP installation directory.

For example, using wamp on Windows, app directory should be C:\wamp\www\cakephp\app\ (if you installed CakePHP in C:\wamp\www\cakephp\).

For further info, check CakePHP Folder Structure.

Where are located console themes?

Console themes are placed inside your app / Console / Templates / directory:

path/to/cakephp/app/Console/Templates/{here}

For further info, check CakePHP Folder Structure.

Where should be located this theme?

As I said in install instructions, content of this theme must be located inside templates directory: app / Console / Templates / {theme_name} /. The default {theme_name} is pretty_cake:

path/to/cakephp/app/Console/Templates/pretty_cake/

What is Git submodule?

Is a Git tool to treat the two projects as separate yet still be able to use one from within the other. Check this page: http://git-scm.com/book/en/v2/Git-Tools-Submodules

TODO List

View actions

  • Personalize 'index' view 🍰
  • Personalize 'view' view 🍰
  • Personalize 'add' view
  • Personalize 'edit' view
  • Add 'delete' view (?)
  • Add 'find' view

Controller actions

  • Personalize 'delete' action
  • Add 'delete' action
  • Add 'find' action

##Licence Licensed under The MIT License (MIT). Check LICENSE for full copyright and license information.