Skip to content

Building Atomic

Ron Severdia edited this page Mar 9, 2026 · 1 revision

The build script packages the Atomic template and sample data plugin into installable Joomla ZIP files.

Requirements

  • macOS or Linux (bash shell)
  • zip command-line utility (pre-installed on macOS)

Repository Structure

Atomic/
├── tpl_atomic/              # Template source
├── plg_sampledata_atomic/   # Sample data plugin source
├── pkg_atomic/              # Package manifest (pkg_atomic.xml)
├── docs/                    # Update server XML files
├── build_package.sh         # Build script
├── .gitignore
├── LICENSE
└── README.md

Running the Build

From the repository root:

bash build_package.sh

The script will:

  1. Read version numbers from the XML manifests (templateDetails.xml, atomic.xml, pkg_atomic.xml)
  2. Remove any .DS_Store files from the source directories
  3. Build three ZIP files in a ZIP/ output directory:
File Description
pkg_atomic_VERSION.zip Install this. Complete Joomla package containing the template and sample data plugin.
tpl_atomic_VERSION.zip Standalone template ZIP (also included inside the package).
plg_sampledata_atomic_VERSION.zip Standalone sample data plugin ZIP (also included inside the package).

Installing

  1. Log in to your Joomla administrator panel
  2. Go to System → Install → Extensions
  3. Upload pkg_atomic_VERSION.zip
  4. The package installs both the template and the sample data plugin

To install components individually, upload the standalone tpl_atomic_ or plg_sampledata_atomic_ ZIP files instead.

Versioning

Version numbers are read directly from the XML manifest files:

  • Template version: tpl_atomic/templateDetails.xml<version>
  • Plugin version: plg_sampledata_atomic/atomic.xml<version>
  • Package version: pkg_atomic/pkg_atomic.xml<version>

To bump a version, edit the <version> tag in the corresponding XML file and re-run the build script.

Clone this wiki locally