Skip to content

Joomla-Bible-Study/Proclaim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CWM Proclaim

A Joomla 4+ component for managing and displaying Bible studies and sermons, developed by a team of web servants to further the teaching of God's Word.

Status

Branch Version Release Date Joomla Version PHP Minimum
Development 10.1.x 4+ PHP
Main 10.0.1 Sep 10, 2025 4+ PHP

Note: The main branch reflects the current stable release. Bug fixes and minor updates go to main; new features go to development only.

Features

  • Content Organization - Manage studies by series, teachers, locations, and topics
  • Media Support - Audio playback, YouTube embedding, and video integration
  • Podcasting - Built-in podcast feed generation
  • Social Sharing - Share content on social media platforms
  • Customizable Templates - Flexible template system for varied presentation
  • Custom Pages - Create your own HTML display pages

Documentation

Quick Start

Prerequisites

  • PHP 8.3.0+
  • Composer
  • Joomla 4+ installation
  • Git

Installation for Development

# Clone your fork
git clone https://github.com/YOUR-USERNAME/Proclaim.git
cd Proclaim

# Install dependencies (creates build.properties from template if missing)
composer install --dev

# Run interactive setup wizard (configures paths and optionally installs Joomla)
composer setup

# Or manually configure build.properties and set up symbolic links
./libraries/vendor/bin/phing dev.Setup_Symbolic_Links

Common Commands

Command Description
composer setup Interactive setup wizard
composer joomla-install Download and install Joomla (choose version)
composer joomla-latest Show latest available Joomla version
composer symlink Create symbolic links to Joomla
composer test Run PHPUnit tests
composer lint Check code style (dry-run)
composer lint:fix Fix code style issues
composer cs Run PHPCS
composer check Run lint + tests together
./libraries/vendor/bin/phing build Full build
./libraries/vendor/bin/phing dev.full-setup Full setup in one command

Contributing

We appreciate contributions in various capacities.

Development Workflow

  1. Fork this repository
  2. Install dependencies: composer install --dev
  3. Run setup wizard: composer setup
  4. Create a topic branch
  5. Implement your feature or bug fix
  6. Add/update unit tests for new functionality
  7. Run composer check to verify lint and tests pass
  8. Commit and push your changes
  9. Submit a pull request

See Development Setup for full details.

Important: Submit separate pull requests for each fix or feature. Avoid combining multiple changes in a single PR.

Translation

Language files need periodic updates. Follow the same workflow above to submit translation changes or add new languages.

Testing

For major releases, we have an approximate 2-week testing window. Contact us if you'd like to help test new versions.

Reporting Issues

Use the Issues section for bug reports or feature requests. When reporting bugs, include steps to reproduce.

Contact

License

See LICENSE.txt for details.