https://github.com/ravage84/cakephp-plugin-skel

A skeleton repo for CakePHP plugins
https://github.com/ravage84/cakephp-plugin-skel

cakephp cakephp-plugin plugin skeleton

Last synced: 10 months ago
JSON representation

A skeleton repo for CakePHP plugins

• Host: GitHub
• URL: https://github.com/ravage84/cakephp-plugin-skel
• Owner: ravage84
• License: mit
• Created: 2014-08-06T23:33:24.000Z (over 11 years ago)
• Default Branch: 2.x
• Last Pushed: 2017-10-13T10:10:30.000Z (over 8 years ago)
• Last Synced: 2025-04-06T22:05:04.046Z (10 months ago)
• Topics: cakephp, cakephp-plugin, plugin, skeleton
• Language: PHP
• Size: 18.6 KB
• Stars: 6
• Watchers: 0
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# cakephp-plugin-skel

A skeleton repo for CakePHP plugins

## Idea & Purpose

The idea behind this repository is quite simple:

Every time you create a CakePHP plugin, you have to setup the folder structure and various auxiliary files, such as ``composer.json`` and ``.travis.yml``.

This repository tries to keep you [DRY](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself) by having setup everything - and most likely much more - you may need to get started writing your own plugin.

**Instead of adding** common files and folders to your plugin folder, you can **remove unneeded files and folders** from it.

## How To Use

1. Download the repository as Zip file.

2. Extract it to ``/path/to/your/cake/install/folder/app/Plugin/[YourPluginName]``

3. Optionally generate the plugin AppController and AppModel by executing

`` shell

cake bake plugin [YourPluginName]

``

4. Integrate your new plugin into your own VCS (See "How To Publish Your Plugin")

5. Delete everything you don't need

6. Start working on your own plugin code by following the

[plugin section in the CakePHP book](http://book.cakephp.org/2.0/en/plugins.html#creating-your-own-plugins)

## How To Publish Your Plugin

Assuming you are going to publish your plugin on GitHub, you should:

- Create a new public GitHub repo named ``your_username/cakephp-[your_plugin_name]``

- Decide what license to use

- Decide whether to use the GitHub Issues

- Decide whether to use the GitHub Wiki

- Adjust the [composer.json](composer.json) by updating the following keys:

  - ``name``

  - ``description``

  - ``keywords``

  - ``homepage``

  - ``authors``, replace the "Lead Developer"

  - ``support``

  - ``require``, if your plugin depends on vendor libraries

  - ``require-dev``, if your plugin depends on vendor libraries for development

  - ``extra/installer-name``, with your plugin name in CamelCase

- Replace [README.md](README.md) by [PLUGIN_README.md](PLUGIN_README.md) and fill the gaps

- Adjust [CONTRIBUTING.md](CONTRIBUTING.md) to your needs

- Consider using/integrating:

   - [Traivs CI](https://travis-ci.org/)

   - [Scrutinizer CI](https://scrutinizer-ci.com/)

   - [Coveralls](https://coveralls.io/)

   - [AppVeyor](http://www.appveyor.com/)

- Adjust the [.travis.yml](.travis.yml) by updating the following:

  - Replace ``PluginSkeleton`` by ``[YourPluginName]``

  - See [FriendsOfcake/Travis](https://github.com/FriendsOfCake/travis) for further options

- Adjust the [Scrutinizer config file](.scrutinizer.yml) to your needs

- Adjust the [AppVeyor config file](appveyor.yml) to your needs

- Push your code to GitHub

- Consult the [CakePHP book](http://book.cakephp.org/2.0/en/plugins.html#publish-your-plugin) for further steps