{"id":16847747,"url":"https://github.com/ravage84/cakephp-plugin-skel","last_synced_at":"2025-04-11T06:32:27.153Z","repository":{"id":19457294,"uuid":"22701729","full_name":"ravage84/cakephp-plugin-skel","owner":"ravage84","description":"A skeleton repo for CakePHP plugins","archived":false,"fork":false,"pushed_at":"2017-10-13T10:10:30.000Z","size":19,"stargazers_count":6,"open_issues_count":11,"forks_count":1,"subscribers_count":0,"default_branch":"2.x","last_synced_at":"2025-04-06T22:05:04.046Z","etag":null,"topics":["cakephp","cakephp-plugin","plugin","skeleton"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ravage84.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-06T23:33:24.000Z","updated_at":"2021-02-15T18:39:15.000Z","dependencies_parsed_at":"2022-08-23T22:40:41.776Z","dependency_job_id":null,"html_url":"https://github.com/ravage84/cakephp-plugin-skel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravage84%2Fcakephp-plugin-skel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravage84%2Fcakephp-plugin-skel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravage84%2Fcakephp-plugin-skel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ravage84%2Fcakephp-plugin-skel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ravage84","download_url":"https://codeload.github.com/ravage84/cakephp-plugin-skel/tar.gz/refs/heads/2.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248355593,"owners_count":21090055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cakephp","cakephp-plugin","plugin","skeleton"],"created_at":"2024-10-13T13:08:57.947Z","updated_at":"2025-04-11T06:32:27.105Z","avatar_url":"https://github.com/ravage84.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cakephp-plugin-skel\n\nA skeleton repo for CakePHP plugins\n\n## Idea \u0026 Purpose\n\nThe idea behind this repository is quite simple:\nEvery time you create a CakePHP plugin, you have to setup the folder structure and various auxiliary files, such as ``composer.json`` and ``.travis.yml``.\n\nThis 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.\n**Instead of adding** common files and folders to your plugin folder, you can **remove unneeded files and folders** from it.\n\n## How To Use\n\n1. Download the repository as Zip file.\n2. Extract it to ``/path/to/your/cake/install/folder/app/Plugin/[YourPluginName]``\n3. Optionally generate the plugin AppController and AppModel by executing\n`` shell\ncake bake plugin [YourPluginName]\n``\n4. Integrate your new plugin into your own VCS (See \"How To Publish Your Plugin\")\n5. Delete everything you don't need\n6. Start working on your own plugin code by following the\n[plugin section in the CakePHP book](http://book.cakephp.org/2.0/en/plugins.html#creating-your-own-plugins)\n\n## How To Publish Your Plugin\n\nAssuming you are going to publish your plugin on GitHub, you should:\n\n- Create a new public GitHub repo named ``your_username/cakephp-[your_plugin_name]``\n- Decide what license to use\n- Decide whether to use the GitHub Issues\n- Decide whether to use the GitHub Wiki\n- Adjust the [composer.json](composer.json) by updating the following keys:\n  - ``name``\n  - ``description``\n  - ``keywords``\n  - ``homepage``\n  - ``authors``, replace the \"Lead Developer\"\n  - ``support``\n  - ``require``, if your plugin depends on vendor libraries\n  - ``require-dev``, if your plugin depends on vendor libraries for development\n  - ``extra/installer-name``, with your plugin name in CamelCase\n- Replace [README.md](README.md) by [PLUGIN_README.md](PLUGIN_README.md) and fill the gaps\n- Adjust [CONTRIBUTING.md](CONTRIBUTING.md) to your needs\n- Consider using/integrating:\n   - [Traivs CI](https://travis-ci.org/)\n   - [Scrutinizer CI](https://scrutinizer-ci.com/)\n   - [Coveralls](https://coveralls.io/)\n   - [AppVeyor](http://www.appveyor.com/)\n- Adjust the [.travis.yml](.travis.yml) by updating the following:\n  - Replace ``PluginSkeleton`` by ``[YourPluginName]``\n  - See [FriendsOfcake/Travis](https://github.com/FriendsOfCake/travis) for further options\n- Adjust the [Scrutinizer config file](.scrutinizer.yml) to your needs\n- Adjust the [AppVeyor config file](appveyor.yml) to your needs\n- Push your code to GitHub\n- Consult the [CakePHP book](http://book.cakephp.org/2.0/en/plugins.html#publish-your-plugin) for further steps\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fravage84%2Fcakephp-plugin-skel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fravage84%2Fcakephp-plugin-skel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fravage84%2Fcakephp-plugin-skel/lists"}