Skip to content

BuddySpuds/PilgrimIRL

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

20 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ‡ฎ๐Ÿ‡ช PilgrimIRL - Discover Ireland's Sacred Heritage

A comprehensive database of Ireland's sacred sites, monasteries, pilgrimage routes, and Christian heritage locations.

Live Site: https://pilgrimirl.com


๐Ÿ“– About

PilgrimIRL is a WordPress-powered platform showcasing over 1,000 sacred sites across Ireland, including:

  • โ›ช Monastic Sites - Ancient monasteries and abbeys
  • ๐Ÿšถ Pilgrimage Routes - Historic walking paths
  • โœ๏ธ Christian Sites - Churches, cathedrals, and holy wells
  • ๐Ÿ“ Interactive Maps - Google Maps integration for each location
  • ๐Ÿ” Advanced Filtering - Search by county, type, order, and era

๐Ÿ› ๏ธ Tech Stack

  • CMS: WordPress 6.x
  • Theme: Custom child theme (twentytwentyfive base)
  • Development: Local by Flywheel
  • Hosting: Hostinger (LiteSpeed, PHP 8.2)
  • CI/CD: GitHub Actions
  • Maps: Google Maps JavaScript API
  • Database: MySQL 8.0
  • Version Control: Git + GitHub

๐Ÿš€ Features

Core Functionality:

  • โœ… 1000+ Sacred Sites Database
  • โœ… Custom Post Types (Monastic Sites, Routes, Christian Sites)
  • โœ… Custom Taxonomies (Counties, Site Types, Religious Orders, Eras)
  • โœ… Interactive Google Maps
  • โœ… Advanced Filtering System
  • โœ… Saints Calendar
  • โœ… Mobile Responsive Design
  • โœ… SEO Optimized (Schema.org, Open Graph)

Technical Features:

  • โœ… AJAX-powered filtering
  • โœ… Custom meta boxes
  • โœ… Geolocation data
  • โœ… SSL/HTTPS enabled
  • โœ… Security hardened
  • โœ… Performance optimized

๐Ÿ“ Project Structure

pilgrimirl/
โ”œโ”€โ”€ .github/
โ”‚   โ””โ”€โ”€ workflows/
โ”‚       โ””โ”€โ”€ deploy-to-hostinger.yml    # CI/CD pipeline
โ”œโ”€โ”€ app/
โ”‚   โ””โ”€โ”€ public/                        # WordPress root
โ”‚       โ”œโ”€โ”€ wp-content/
โ”‚       โ”‚   โ”œโ”€โ”€ themes/
โ”‚       โ”‚   โ”‚   โ””โ”€โ”€ pilgrimirl/        # Custom theme
โ”‚       โ”‚   โ”œโ”€โ”€ plugins/               # Installed plugins
โ”‚       โ”‚   โ””โ”€โ”€ mu-plugins/            # Must-use plugins
โ”‚       โ””โ”€โ”€ wp-config.php              # WP configuration (gitignored)
โ”œโ”€โ”€ deployment/                        # Deployment backups (gitignored)
โ”œโ”€โ”€ .env                               # Credentials (gitignored)
โ”œโ”€โ”€ .gitignore                         # Git exclusions
โ”œโ”€โ”€ auto-deploy.sh                     # Manual deployment script
โ”œโ”€โ”€ README.md                          # This file
โ”œโ”€โ”€ CI_CD_SETUP.md                     # CI/CD documentation
โ”œโ”€โ”€ LIVE_SITE_REVIEW.md                # Post-deployment review
โ””โ”€โ”€ README_DEPLOY.md                   # Deployment guide

๐Ÿ—๏ธ Development Setup

Prerequisites:

  • Local by Flywheel - WordPress local development
  • Git - Version control
  • GitHub account - Code hosting & CI/CD
  • Node.js (optional) - If building assets

Setup Instructions:

  1. Clone Repository:

    git clone https://github.com/YOUR-USERNAME/pilgrimirl.git
    cd pilgrimirl
  2. Import to Local:

    • Open Local by Flywheel
    • Add Existing Site โ†’ Choose /pilgrimirl/ folder
    • Start site
  3. Access Local Site:

  4. Make Changes:

    • Edit theme files in app/public/wp-content/themes/pilgrimirl/
    • Test locally
    • Commit changes
  5. Deploy:

    git add .
    git commit -m "feat: your feature description"
    git push origin main  # Automatically deploys!

๐Ÿ”„ Deployment

Automated Deployment (Recommended):

Push to GitHub โ†’ Auto-deploys to Hostinger via GitHub Actions

See CI_CD_SETUP.md for full instructions.

Manual Deployment:

# From Local shell
cd /Users/robertporter/Local\ Sites/pilgrimirl
./auto-deploy.sh

๐ŸŽจ Theme Development

Custom Theme: pilgrimirl

Location: app/public/wp-content/themes/pilgrimirl/

Key Files:

  • functions.php - Theme setup, enqueues, custom post types
  • style.css - Theme stylesheet
  • archive-*.php - Archive templates for custom post types
  • single-*.php - Single post templates
  • template-parts/ - Reusable template components
  • assets/ - CSS, JS, images

Custom Post Types:

  1. monastic_site - Monastic Sites
  2. pilgrimage_route - Pilgrimage Routes
  3. christian_site - Christian Heritage Sites

Custom Taxonomies:

  • county - Irish counties
  • site_type - Type of site
  • religious_order - Religious orders
  • era - Historical era

๐Ÿ” Security

Implemented Measures:

  • โœ… File editing disabled in production
  • โœ… SSL/HTTPS enforced
  • โœ… Debug mode off in production
  • โœ… Proper file permissions (755/644)
  • โœ… wp-config.php protected
  • โœ… Input sanitization & output escaping
  • โœ… CSRF protection (nonces)
  • โœ… SQL injection prevention (prepared statements)

Security Score: 95/100

See SECURITY_AUDIT_REPORT.md for details.


๐ŸŽฏ SEO Optimization

Implemented:

  • โœ… Schema.org structured data (TouristAttraction)
  • โœ… Dynamic meta descriptions
  • โœ… Open Graph tags
  • โœ… Twitter Cards
  • โœ… Canonical URLs
  • โœ… XML Sitemaps
  • โœ… Robots.txt
  • โœ… Hreflang tags

SEO Score: 92/100

See SEO_AUDIT.md for details.


๐Ÿ“Š Performance

Current Status:

  • Server Response: ~200-500ms
  • HTTP/2: โœ… Enabled
  • SSL: โœ… Enabled
  • Server: LiteSpeed

Recommended Enhancements:

  • Install caching plugin (WP Rocket)
  • Optimize images (ShortPixel)
  • Enable CDN
  • Minify CSS/JS

๐Ÿงช Testing

Manual Testing Checklist:

  • Homepage loads correctly
  • Archive pages work (sites, routes)
  • Individual site pages display
  • Maps render correctly
  • Filters function properly
  • Calendar displays
  • Search works
  • Mobile responsive
  • Cross-browser compatible

๐Ÿ“ Documentation

  • README.md - Project overview (this file)
  • CI_CD_SETUP.md - GitHub Actions setup guide
  • README_DEPLOY.md - Automated deployment guide
  • DEPLOYMENT_GUIDE.md - Manual deployment guide
  • LIVE_SITE_REVIEW.md - Post-deployment checklist
  • SEO_AUDIT.md - SEO optimization report
  • SECURITY_AUDIT_REPORT.md - Security assessment

๐Ÿค Contributing

Workflow:

  1. Create feature branch: git checkout -b feature/your-feature
  2. Make changes and test locally
  3. Commit: git commit -m "feat: description"
  4. Push: git push origin feature/your-feature
  5. Create Pull Request on GitHub
  6. After review, merge to main
  7. Automatically deploys to production!

Commit Conventions:

  • feat: New feature
  • fix: Bug fix
  • style: CSS/design changes
  • docs: Documentation
  • refactor: Code refactoring
  • test: Testing updates
  • chore: Maintenance tasks

๐Ÿ“ž Support & Resources

Documentation:

Hosting:

Development:


๐Ÿ“œ License

Proprietary - All rights reserved.


๐Ÿ‘ค Author

PilgrimIRL Development Team


๐ŸŽ‰ Acknowledgments

  • WordPress Community
  • Twenty Twenty-Five Theme
  • Google Maps Platform
  • Hostinger Hosting
  • Local by Flywheel
  • GitHub Actions

Site Status: ๐ŸŸข LIVE & OPERATIONAL

Last Updated: November 24, 2025


๐Ÿš€ Quick Links


Discover Ireland's sacred heritage. One site at a time. ๐Ÿ‡ฎ๐Ÿ‡ชโ›ช

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors