https://github.com/joomla-extensions/boilerplate

Boilerplate files for Joomla! extensions
https://github.com/joomla-extensions/boilerplate

boilerplate boilerplate-files joomla phpstorm templates

Last synced: 3 months ago
JSON representation

Boilerplate files for Joomla! extensions

• Host: GitHub
• URL: https://github.com/joomla-extensions/boilerplate
• Owner: joomla-extensions
• License: gpl-2.0
• Created: 2016-06-28T08:08:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-30T07:59:15.000Z (over 1 year ago)
• Last Synced: 2024-08-02T03:01:26.716Z (6 months ago)
• Topics: boilerplate, boilerplate-files, joomla, phpstorm, templates
• Language: PHP
• Size: 237 KB
• Stars: 97
• Watchers: 27
• Forks: 89
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-joomla - joomla-extensions/boilerplate - Boilerplate files for Joomla! extensions (Development / Extension Development)

README

        
# Boilerplate

Boilerplate files for Joomla! extensions.

# Installation

The boilerplates can be installed as-is using the Extension Manager. However, the component, module and plugin will be called Foo :)

To create installable zip packages, you only need to zip the folder with the files and it is ready to be installed.

# Customizing

To customize the boilerplates using your own name you need to take the following steps:

1. Do a **case-sensitive** replace on the following strings and replace them with your own name:

   * foo

   * Foo

   * FOO

2. Do a **case-sensitive** replace on the following tags with their actual information:

   * [DATE]

   * [PROJECT_NAME]

   * [AUTHOR]

   * [AUTHOR_EMAIL]

   * [AUTHOR_URL]

   * [COPYRIGHT]

   * [PACKAGE_NAME]

   

# Changing the repository layout [ 2019-12-22 ]

In hindsight putting the code in the root of the repository was not the

best of ideas ;)

Moving forward with Joomla 4, all source code will be in the **src** folder

and the main folders will remain as they are used by PhpStorm and removing

them would break the installations of those using older PhpStorm versions.

Another change in the code will be that **foo** will be replaced by **joomlaboilerplate**

because the word foo is not unique enough for replacements. For example it

also matches part of the word **footer**.

Furthermore the J3 component will be extended to include a sample of a

listing view and an edit view.

The J4 component is taken from [Astridx](https://github.com/astridx/boilerplate) who I want to thank for her contribution.