Digital Handbook

Appearance

SallysaPizza.com ​

Website: sallysapizza.com

Staging: staging-sallys-staging.kinsta.cloud

Development URL: sallys.test (local development)

BrowserSync: localhost:3000 (development server)

Sophisticated WordPress website built on the Roots Sage framework with custom "Fir Theme" featuring a block-based architecture using 40+ custom "Pinecones" (ACF blocks) and modern Laravel-style development patterns.

Billing ​

Hosting Platform ​

Current Hosting ​

  • Provider: Kinsta (Google Cloud Platform infrastructure)
  • Plan/Tier: Kinsta managed WordPress hosting
  • Server Location: Google Cloud Platform (IP: 34.162.230.19)
  • SSL Certificate: Let's Encrypt (ready but currently disabled)
  • Server Stack: LEMP (Linux, Nginx, MariaDB MySQL, PHP 8.0)
  • Development URL: https://sallys.test
  • BrowserSync: http://localhost:3000

Domain Management ​

  • Domain Registrar: To be documented
  • DNS Provider: To be documented
  • CDN: Kinsta's built-in CDN
  • Production Domain: sallysapizza.com (www redirects to non-www)
  • Staging Domain: staging-sallys-staging.kinsta.cloud

Technical Stack ​

  • Framework: WordPress with Roots Sage 10.3.1 + Custom Fir Theme
  • PHP Version: >= 8.1
  • WordPress Version: >= 5.9
  • Laravel Integration: Acorn v2 for Laravel components
  • Build System: Bud.js (Roots' webpack wrapper)
  • Styling: Tailwind CSS + PostCSS with custom plugins
  • JavaScript: Vue.js components for interactivity
  • Block System: 40+ custom "Pinecones" (ACF blocks)
  • Backup Strategy: Kinsta managed backup system with automated daily backups
  • Deployment: Trellis + Ansible automation with Bitbucket integration
  • Caching: Memcached (server-level) + Kinsta CDN with automated cache clearing

Project Info ​

Project Details ​

  • Start Date: To be documented
  • Launch Date: To be documented
  • Project Status: To be documented
  • Last Updated: To be documented

Client Contact ​

  • Primary Contact: Sally's Pizza Team
  • Email: To be documented
  • Phone: To be documented
  • Role/Title: To be documented

Project Team ​

  • Project Manager: To be documented
  • Developer(s): To be documented
  • Designer: To be documented
  • Content Manager: To be documented

Notes ​

Development Notes ​

  • Architecture: Custom "Fir" system with Laravel-style patterns via Acorn
  • Block System: 40+ self-contained Pinecone components with PHP, Blade, Vue.js, CSS, and JS
  • Namespaces: App\ namespace for theme PHP, Fir\ namespace for custom framework
  • Build Targets: Dual frontend and editor builds with separate configurations
  • Development Workflow: Use yarn dev for file watching and BrowserSync
  • Deployment Process: Trellis/Ansible automation via ansible-playbook deploy.yml
  • Build Process: Pre-deployment hooks run npm run build for asset compilation
  • Repository: Bitbucket (main branch for production, staging branch for staging)
  • Cache Management: Automatic Kinsta cache clearing post-deployment
  • Code Quality: PSR-12 PHP standards with composer lint

Content Updates ​

  • Block Management: Custom Pinecone CLI for creating/managing ACF blocks
  • Templates: Blade templating system in /resources/views/
  • Custom Post Types: Events, jobs, merchandise
  • ACF Integration: Advanced Custom Fields for flexible content management
  • Translation Ready: i18n support with POT/PO/MO compilation

Client Feedback ​

  • Modern Development: Laravel-style architecture brings modern patterns to WordPress
  • Block-Based Content: Flexible Pinecone system allows rich content creation
  • Developer Experience: Sophisticated tooling with Bud.js build system
  • Performance: Optimized build process with separate frontend/editor targets

Performance Notes ​

  • Build System: Bud.js optimization with PostCSS and Tailwind CSS
  • Asset Management: Separate frontend and editor builds for optimized loading
  • Development Server: BrowserSync for fast development iteration
  • Code Splitting: Vue.js components loaded as needed
  • CSS Optimization: PostCSS with custom plugins and variables

Third Party Services ​

Analytics & Tracking ​

  • Google Analytics: Account details to be documented
  • Tag Manager: Container information to be documented

Content Management ​

  • To be documented

Development Tools ​

  • Repository: Bitbucket (git@bitbucket.org:drbroad/sallysappiza.git)
  • Build Pipeline: Trellis/Ansible with Bud.js for asset compilation
  • Package Manager: Yarn for dependency management
  • Code Quality: Composer for PHP linting (PSR-12)
  • CLI Tools: Custom Pinecone CLI for block management
  • Translation Tools: WordPress i18n with automated POT/PO/MO compilation
  • Server Management: Ansible playbooks for provisioning and deployment

Credentials / Keys ​

Hosting & Domain ​

  • Kinsta Account: Managed WordPress hosting with SSH access
  • Domain Management: DNS and SSL certificate management
  • Server Access: SSH keys (Production: Port 33925, Staging: Port 64171)
  • Ansible Vault: Encrypted storage for sensitive credentials

Development ​

  • Repository Access: Bitbucket SSH key authentication
  • Environment Variables: WordPress configuration managed via Trellis
  • Local Development: Vagrant environment with sallys.test domain
  • Build Commands: yarn dev, yarn build, yarn clean, yarn dr
  • Deployment Commands: ansible-playbook deploy.yml -e env=production

Third Party Services ​

  • Advanced Custom Fields: Custom field management and Pinecone blocks
  • Roots Ecosystem: Sage framework and Bud.js build system
  • Laravel Acorn: Laravel components integration for WordPress
  • PostCSS Plugins: Advanced variables, editor styles, prefix selector
  • Animation Libraries: GSAP, Splide, Embla Carousel, Swiper, Tiny Slider
  • Form Validation: Just Validate library
  • Date Picker: Easepick with lock plugin

APIs & Integrations ​

  • WordPress REST API: Core WordPress API integration
  • ACF REST API: Advanced Custom Fields API endpoints
  • Pinecone CLI: Custom block management via command line
  • Axios: HTTP client for API requests
  • Partytown: Third-party script optimization

Security ​

  • SSL Certificates: Let's Encrypt automation (currently disabled)
  • Server Security: Fail2ban, SSH key authentication, firewall (Ferm)
  • Access Control: SSH IP whitelisting, sudo privileges for admin user
  • WordPress Security: XML-RPC and wp-login protection via fail2ban
  • Code Standards: PSR-12 PHP standards with automated linting
  • Environment Protection: Ansible vault for sensitive data encryption

⚠️ Security Note: All sensitive credentials and API keys should be stored securely using proper credential management systems. This documentation should only reference the location or method to access credentials, not the actual sensitive information.

Development Commands ​

bash
# Primary Development
yarn dev          # Development with file watching and Browsersync
yarn build        # Production build
yarn clean        # Clean build artifacts
yarn dr           # Build system diagnostics

# Code Quality
composer lint     # PHP linting (PSR-12 standard)

# Pinecone Block Management
yarn pinecone                    # View Pinecone CLI help
yarn pinecone:make [block-name]  # Create new Pinecone block
yarn pinecone:remove [block-name] # Remove Pinecone block
yarn pinecone:import             # Import Pinecone from repository
yarn pinecone:update             # Update existing Pinecones

# Translation/Internationalization
yarn translate        # Generate and update translation files
yarn translate:pot    # Generate .pot file
yarn translate:update # Update .po files
yarn translate:compile # Compile translations to .mo and .js

Website Features ​

Custom Block System ​

  • 40+ Pinecone Blocks: Self-contained ACF blocks with PHP, Blade, Vue.js, CSS, and JS
  • Block CLI Management: Create, remove, import, and update blocks via command line
  • Flexible Content: Advanced Custom Fields integration for rich content management
  • Admin Interface: Custom admin styles and editor experience

Modern Development Stack ​

  • Laravel Integration: Acorn v2 brings Laravel components to WordPress
  • Blade Templating: Modern templating system with inheritance and components
  • Vue.js Components: Interactive frontend components with modern JavaScript
  • Tailwind CSS: Utility-first CSS framework with PostCSS optimization

Advanced Features ​

  • Animation Libraries: GSAP, Splide, Embla Carousel, Swiper for rich interactions
  • Form Validation: Just Validate for client-side form validation
  • Date Management: Easepick date picker with lock plugin
  • Performance Optimization: Partytown for third-party script optimization

Developer Experience ​

  • Hot Reload: BrowserSync with file watching for fast development
  • Build Optimization: Separate frontend and editor builds for performance
  • Code Quality: Automated PHP linting with PSR-12 standards
  • Translation Ready: Complete i18n workflow with automated compilation

Content Management ​

  • Custom Post Types: Events, jobs, merchandise management
  • Block-Based Editing: Gutenberg integration with custom Pinecone blocks
  • Flexible Layouts: ACF-powered flexible content areas
  • Multi-language Support: WordPress i18n with POT/PO/MO workflow

Contact Information ​

Website: sallysapizza.com

Development URL: sallys.test (local development)

BrowserSync: localhost:3000 (development server)

Additional contact details to be added