Skip to content
Brent Cordis edited this page Mar 15, 2026 · 19 revisions

Welcome to the Proclaim Wiki!

CWM Proclaim is a Joomla 5.1+ component for managing and displaying Bible studies and sermons. Built by a team of web servants to further the teaching of God's Word.

Branch Version Release Date Joomla PHP
Main 10.2.0 Mar 15, 2026 5.1+ / 6.0 8.3.0+
Development 10.3.x - 5.1+ / 6.0 8.3.0+

Features

  • Content Management - Organize studies by series, teachers, locations, and topics
  • Media Support - Audio playback, YouTube/Vimeo/Wistia embedding, video chapters, interactive transcripts
  • Podcasting - Built-in podcast feed generation with multi-platform links
  • Social Sharing - Share studies on social media with GDPR-compliant local option
  • Customizable Templates - Visual drag-and-drop Layout Editor for custom displays
  • Multi-Campus - Location-based content isolation for multi-site installations
  • Analytics - Play/download tracking with drill-down dashboard and printable reports
  • AI Assist - Topic suggestion, description generation, and chapter timestamps

Quick Start

# Clone and install
git clone https://github.com/YOUR-USERNAME/Proclaim.git
cd Proclaim
composer install --dev
npm install

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

# Or manually set up symlinks
composer symlink

Common Commands

Command Description
composer setup Interactive setup wizard
composer joomla-install Download and install Joomla
composer symlink Create symbolic links to Joomla
composer test Run PHPUnit tests
composer check Run syntax + lint + tests
composer check:all Run all checks + all tests (PHP + JS)
composer lint:fix Fix code style issues
composer build Build component package (zip)
composer build:full Run all checks then build

See Development Setup for full details.

Documentation

Document Description
What's New v10.2 Chapters, subtitles, transcripts, YouTube OAuth, Google Drive addon
What's New v10.1 Layout Editor, multi-campus, analytics, CSV import, scripture redesign
Upgrading from 9.x Step-by-step guide for migrating from Proclaim 9.x to 10.x
B/C Breaks in 10.1 Backward compatibility breaks from 10.0.x to 10.1.0
Multi-Campus Admin Guide Set up and manage location-based campus separation
Multi-Campus User Guide Day-to-day guide for campus content editors
Location API Reference Developer reference for CwmlocationHelper and the location system
Requirements Project requirements, goals, and success metrics
Plan Implementation strategy and improvement roadmap
Tasks Actionable improvement tasks with progress tracking
Development Setup How to set up your development environment
Standards and Conventions Coding standards and conventions
Roadmap Release schedule and versioning

Quick Links

Contributing

Want to help develop Proclaim?

  1. Fork the repository
  2. Run composer install --dev && npm install then composer setup
  3. See Development Setup for full details
  4. Submit a pull request

Questions? Email us your GitHub ID to join the project.

Clone this wiki locally