At Your Service - WordPress Plugin# At Your Service WordPress Plugin

A feature-rich, scalable, and customizable plugin designed for service-based businesses like cleaning services, gardeners, plumbers, and more. This plugin offers lead generation, job management, invoicing, and much more, all built on top of WordPress's flexible architecture.

<<<<<<< Updated upstream

<<<<<<< Updated upstream

Transform your service-based business with At Your Service – the ultimate WordPress plugin for contractors, cleaners, plumbers, gardeners, and more. Streamline operations, boost leads, and manage jobs like a pro with powerful CRM, invoicing, and dynamic pricing tools.At Your Service is a flexible WordPress plugin specifically designed for service-based businesses. It offers lead generation, job management, invoicing, and custom post types. Gutenberg service blocks and shortcode support allow users to easily create and manage forms. The plugin is built on modern PHP practices, ensuring scalability and maintainability. It includes dynamic pricing calculations, ideal for providing instant quotes. The architecture is extensible, allowing for seamless integration of additional features such as CRM and subscription services. It is mobile-optimized and supports internationalization with built-in translation files.

🚀 Why Choose At Your Service?# Minimum Requirements

Tired of juggling spreadsheets, emails, and manual invoicing? At Your Service empowers service businesses to scale efficiently. Built for WordPress, it integrates seamlessly with your site while providing enterprise-level features for lead generation, job tracking, and customer management.At Your Service is a flexible WordPress plugin specifically designed for service-based businesses. It offers lead generation, job management, invoicing, and custom post types. Gutenberg service blocks and shortcode support allow users to easily create and manage forms. The plugin is built on modern PHP practices, ensuring scalability and maintainability. It includes dynamic pricing calculations, ideal for providing instant quotes. The architecture is extensible, allowing for seamless integration of additional features such as CRM and subscription services. It is mobile-optimized and supports internationalization with built-in translation files.

Key Benefits:Minimum Requirements

• Lead Magnet: Capture more customers with customizable forms and instant quote calculators.

• Operational Efficiency: Automate job management, invoicing, and customer follow-ups.> > > > > > > Stashed changes

• Scalable & Extensible: Modern OOP architecture ready for customizations and integrations.=======

• Mobile-First: Optimized for all devices, ensuring your business shines everywhere.At Your Service is a flexible WordPress plugin specifically designed for service-based businesses. It offers lead generation, job management, invoicing, and custom post types. Gutenberg service blocks and shortcode support allow users to easily create and manage forms. The plugin is built on modern PHP practices, ensuring scalability and maintainability. It includes dynamic pricing calculations, ideal for providing instant quotes. The architecture is extensible, allowing for seamless integration of additional features such as CRM and subscription services. It is mobile-optimized and supports internationalization with built-in translation files.

✨ FeaturesMinimum Requirements

Stashed changes

Lead Generation & Forms

• Dynamic Quote Calculator: Real-time pricing based on user selections – no more guesswork!WordPress 5.0 or greater

• Gutenberg Blocks: Drag-and-drop service forms for easy page building.PHP version 7.0 or greater

• Shortcodes: Embed lead forms anywhere with responsive, mobile-optimized designs.

• Customizable Templates: Tailor forms to match your brand.At Your Service is the go-to solution for businesses looking to streamline operations and enhance customer management within WordPress.

Job & Customer Management## Contents

• CRM Integration: Track customer interactions, history, and preferences.

• Job Tracking: Organize jobs by status, assign teams, and monitor progress.The At Your Service Plugin includes the following files and features:

• Customer Profiles: Store details, payment history, and service preferences.

• .gitignore: Files excluded from the repository.

Invoicing & Payments- README.md: The document you're currently reading, detailing the plugin setup and usage.

• Automated Invoicing: Generate professional invoices with one click.- CHANGELOG.md: A log of changes and updates made to the plugin.

• Payment Tracking: Monitor credits, debts, and payment statuses.- ays/ directory: The main directory containing the plugin's source code. This includes class definitions for custom post types and taxonomies, JavaScript and CSS assets, template files for forms, and additional components such as hooks and utilities that power the plugin’s functionality.

• Tax & Discount Support: Handle complex pricing scenarios effortlessly.- Shortcodes for Non-Gutenberg Users: We provide powerful shortcodes for integrating lead generation forms into any part of your site, optimized for responsive design. The landing page layout is crafted for high conversions and includes:

Technical Excellence - Two-Column Responsive Layout: A fully responsive two-column design, perfect for showcasing your business with a combination of visual content and lead capture forms.

• OOP Architecture: Clean, maintainable code using singletons and design patterns. - Dynamic Headline and Subheadline: Easily customizable headline (H1) and subheadline (H2) sections that can dynamically display your city or service.

• Internationalization: Ready for translations with included .pot files. - Engaging Visual Content: The left column includes space for images or videos that help convey your service’s value visually, optimized for different screen sizes with a flexible image layout.

• SEO Optimized: Built-in best practices for search engine visibility. - Service Pitch Section: A text section to deliver your pitch, limited to 6 lines with CSS's clamp feature to keep the message concise and impactful.

• Extensible: Hooks and filters for easy customization and third-party integrations. - Lead Capture Form: The right column features a fully functional form, with inputs for name, email, phone, and checkboxes for selecting services . The form is styled for accessibility and ease of use.

  • Call to Action: Includes a prominent "Book In" button for easy user engagement. It also features a checkbox to confirm the user is "Not a Robot" and a fallback option to call your business directly if needed, with a dynamic phone number.

📋 Requirements<<<<<<< Updated upstream

<<<<<<< Updated upstream

• WordPress: 5.0 or higher

• PHP: 7.2 or higherThis shortcode is designed to be mobile-optimized, ensuring it looks great across all devices, whether on mobile or desktop. It's the perfect way to capture leads while presenting your service professionally.

• MySQL: 5.6 or higher (or MariaDB equivalent)

=======

🛠 Installation

This shortcode is designed to be mobile-optimized, ensuring it looks great across all devices, whether on mobile or desktop. It's the perfect way to capture leads while presenting your service professionally.

Option 1: WordPress Dashboard (Recommended for Beginners)

1. Download the plugin ZIP from the releases page.> > > > > > > changes

2. In your WordPress admin, go to Plugins > Add New > Upload Plugin.=======

3. Upload the ZIP file and click Install Now.

4. Activate the plugin and configure your settings.This shortcode is designed to be mobile-optimized, ensuring it looks great across all devices, whether on mobile or desktop. It's the perfect way to capture leads while presenting your service professionally.

Stashed changes

Option 2: Manual Upload

1. Download and unzip the plugin files.## Features

2. Upload the At-Your-Services folder to /wp-content/plugins/.

3. Activate via Plugins in your WordPress dashboard.- Lead Generation: Collect and manage leads with a built-in cost calculator, quote generator, and Gutenberg service blocks.

• Shortcodes for Non-Gutenberg Users: Shortcodes are available for integrating lead generation forms into landing page.

Option 3: Developer Setup- Job Management: Organize and track jobs through various stages of the business process.

cd wp-content/plugins- **OOP-Based Architecture**: Leverages modern PHP practices like singletons and the State pattern to ensure maintainability and scalability.

git clone https://github.com/shaunpalmer/At-Your-Services.git- **Custom Post Types**: Use multiple custom post types like 'services' to organize data for service businesses.

wp plugin activate At-Your-Services- **Live Pricing Calculations**: Dynamic service pricing based on user inputs, designed to provide instant quotes.

```- **Extensible Architecture**: Easy to add new features and blocks via a well-organized structure that keeps logic and presentation separate.

- **Internationalization Ready**: Built-in support for translations with a `.pot` file included.

## 🎯 Usage- **Mobile-Optimized**: Focused on performance for mobile users, ensuring the plugin is SEO-friendly.



### Quick Start## Installation

1. **Activate the Plugin**: Head to your WordPress plugins page and activate "At Your Service".

2. **Configure Settings**: Navigate to the plugin settings to set up your business details, pricing, and forms.### For Regular Users

3. **Add Forms**: Use shortcodes like `[ays_lead_form]` or Gutenberg blocks to embed lead capture forms on your pages.

4. **Manage Jobs**: Access the admin dashboard to track jobs, generate invoices, and view customer data.1. **Upload via WordPress Dashboard**:

<<<<<<< Updated upstream

### Shortcode Examples   <<<<<<< Updated upstream - Download the plugin zip file. - Navigate to the 'Plugins' screen in your WordPress dashboard. - Click 'Add New', then 'Upload Plugin'. - Select the plugin zip file, upload it, and activate it.

- Basic lead form: `[ays_lead_form]`

- Service-specific form: `[ays_service_form service="cleaning"]`2. # **Begin Configuration**: - Go to the plugin settings to configure lead generation forms, job tracking, invoicing, and other features.

- Quote calculator: `[ays_quote_calculator]`=======

>>>>>>> Stashed changes

### Gutenberg Blocks

- **Service Lead Block**: Drag into any page for instant form creation.   - Download the plugin zip file.

- **Pricing Calculator**: Interactive block for dynamic quotes.   - Navigate to the 'Plugins' screen in your WordPress dashboard.

   - Click 'Add New', then 'Upload Plugin'.

## 📸 Screenshots   - Select the plugin zip file, upload it, and activate it.



*(Coming soon – add screenshots of your forms, admin dashboard, and frontend displays)*3. **Begin Configuration**:

   - Go to the plugin settings to configure lead generation forms, job tracking, invoicing, and other features.

## 🤝 Contributing<<<<<<< Updated upstream

     > > > > > > > Stashed changes

We welcome contributions! Here's how you can help:=======

>>>>>>> Stashed changes

1. Fork the repository.

2. Create a feature branch: `git checkout -b feature/amazing-new-feature`.### For Developers

3. Commit your changes: `git commit -m 'Add amazing new feature'`.

4. Push to the branch: `git push origin feature/amazing-new-feature`.1. **Using Git and WP-CLI**:

5. Open a Pull Request.<<<<<<< Updated upstream

   <<<<<<< Updated upstream - Clone the repository to your WordPress plugins directory:

### Development Setup   `bash

- Clone the repo and run `composer install` for dependencies.git clone https://github.com/shaunpalmer/At-Your-Services wp-content/plugins/atyourservice

- Use WP-CLI for testing: `wp plugin activate At-Your-Services --debug`.` - Navigate to the plugin folder and activate the plugin via WP-CLI:

- Follow our coding standards in `Coding style guide.md`.   `bash

wp plugin activate atyourservice

## 📄 License`



This plugin is licensed under the GPL v2 or later.## Task Automation with NPM



```We use **npm scripts** for automating common tasks such as building the project, running linters, and managing git hooks. Below is a step-by-step guide for setting up automation for your project. 2. **Using NPM and WP-Scripts**: - Install dependencies:

Copyright (C) 2024-2030 Shaun Palmer`##bash

      npm install

This program is free software; you can redistribute it and/or modify     ` - Build the plugin using the official WordPress scripts:

it under the terms of the GNU General Public License as published by`bash

the Free Software Foundation; either version 2 of the License, or      npm run build  

(at your option) any later version.      ` - For development mode:

`bash

This program is distributed in the hope that it will be useful,      npm run start

but WITHOUT ANY WARRANTY; without even the implied warranty of      `

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`   npx husky add .husky/pre-commit "npm run lint"

GNU General Public License for more details.      git add .husky/pre-commit

  `

You should have received a copy of the GNU General Public License along=======

with this program; if not, write to the Free Software Foundation, Inc.,

51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.- Clone the repository to your WordPress plugins directory:

```  ```bash

  git clone https://github.com/shaunpalmer/At-Your-Services wp-content/plugins/atyourservice

## 👨‍💻 Author  ```

- Navigate to the plugin folder and activate the plugin via WP-CLI:

**Shaun Palmer**    ```bash

- Website: [project-studios.nz](https://project-studios.nz)    wp plugin activate atyourservice

- Email: shaun@project-studios.nz or shaun.palmer@gmail.com    ```

- GitHub: [@shaunpalmer](https://github.com/shaunpalmer)

## Task Automation with NPM

Built with ❤️ for service businesses worldwide.

We use **npm scripts** for automating common tasks such as building the project, running linters, and managing git hooks. Below is a step-by-step guide for setting up automation for your project. 2. **Using NPM and WP-Scripts**: - Install dependencies:

---`##bash

      npm install

*Ready to supercharge your service business? Install At Your Service today!* 🚀     ` - Build the plugin using the official WordPress scripts:
`bash
      npm run build  
      ` - For development mode:
`bash
      npm run start
      `
`  npx husky add .husky/pre-commit "npm run lint"
      git add .husky/pre-commit
 `

> > > > > > > Stashed changes
=======
   - Clone the repository to your WordPress plugins directory:
     ```bash
     git clone https://github.com/shaunpalmer/At-Your-Services wp-content/plugins/atyourservice

• Navigate to the plugin folder and activate the plugin via WP-CLI:

  wp plugin activate atyourservice

Task Automation with NPM

We use npm scripts for automating common tasks such as building the project, running linters, and managing git hooks. Below is a step-by-step guide for setting up automation for your project.

Stashed changes

2. Using NPM and WP-Scripts:

   • Install dependencies:

     npm install

   • Build the plugin using the official WordPress scripts:

     npm run build

   • For development mode:

     npm run start

     npx husky add .husky/pre-commit "npm run lint"
     git add .husky/pre-commit

     NPM Automation and Build Setup

To streamline the development process, we’ve incorporated several tools using NPM for task automation, linting, and building packages. This section explains how to set up and use these tools in your project.

<<<<<<< Updated upstream <<<<<<< Updated upstream

1. Initialize the Project

=======

1. Initialize the Project

Stashed changes If you haven’t initialized your project yet, start by running:

1. Initialize the Project

If you haven’t initialized your project yet, start by running:

Stashed changes

npm init -y

Custom Post Types and Taxonomies

This plugin includes several Custom Post Types and Taxonomies to enhance the functionality of your WordPress site. Below is a list of the custom post types and taxonomies included, along with their purposes and locations within the project structure.

Custom Post Types

<<<<<<< Updated upstream

<<<<<<< Updated upstream | Post Type | Description | Class Name | File Location | | ------------ | --------------------------------------------------- | ------------------ | -------------------------------------------- | | Services | Different kinds of services offered by the business. | Ays_CPT_Service | includes/post-types/ays-cpt-service.php | | Teams | Teams within the organization. | Ays_CPT_Team | includes/post-types/ays-cpt-team.php | | FAQs | Frequently Asked Questions related to services. | Ays_CPT_FAQ | includes/post-types/ays-cpt-faq.php | | Reviews | Customer reviews and testimonials. | Ays_CPT_Review | includes/post-types/ays-cpt-review.php | | Locations| Business or service locations. | Ays_CPT_Location | includes/post-types/ays-cpt-location.php |

Taxonomies

Taxonomy	Description	Class Name	File Location
Service Type	Categorizes services by type (e.g., Cleaning, Plumbing, etc.).	Ays_Taxonomy_Service_Type	includes/taxonomies/ays-taxonomy-service-type.php
Price Range	Categorizes services based on pricing tiers (e.g., Budget, Premium).	Ays_Taxonomy_Price_Range	includes/taxonomies/ays-taxonomy-price-range.php

=======

Stashed changes

Post Type	Description	Class Name	File Location
Services	Different kinds of services offered by the business.	Ays_CPT_Service	includes/post-types/ays-cpt-service.php
Teams	Teams within the organization.	Ays_CPT_Team	includes/post-types/ays-cpt-team.php
FAQs	Frequently Asked Questions related to services.	Ays_CPT_FAQ	includes/post-types/ays-cpt-faq.php
Reviews	Customer reviews and testimonials.	Ays_CPT_Review	includes/post-types/ays-cpt-review.php
Locations	Business or service locations.	Ays_CPT_Location	includes/post-types/ays-cpt-location.php

Taxonomies

Taxonomy	Description	Class Name	File Location
Service Type	Categorizes services by type (e.g., Cleaning, Plumbing, etc.).	Ays_Taxonomy_Service_Type	includes/taxonomies/ays-taxonomy-service-type.php
Price Range	Categorizes services based on pricing tiers (e.g., Budget, Premium).	Ays_Taxonomy_Price_Range	includes/taxonomies/ays-taxonomy-price-range.php

<<<<<<< Updated upstream

Stashed changes

Stashed changes

Project Structure

• /includes: Shared functionality between the admin and public-facing areas.
• /admin: Admin-specific features, including settings pages.
• /public: Public-facing features, including front-end form logic.
• /assets: Stylesheets, JavaScript, and other assets.

• /templates: Custom templates for lead generation forms and job management. <<<<<<< Updated upstream <<<<<<< Updated upstream

changes

Stashed changes

/ays/
├── includes/
│   ├── post-types/
│   │   ├── ays-cpt-service.php      # Custom post type for services
│   │   ├── ays-cpt-team.php         # Custom post type for teams
│   │   ├── ays-cpt-faq.php          # Custom post type for FAQs
│   │   ├── ays-cpt-review.php       # Custom post type for reviews
│   │   └── ays-cpt-location.php     # Custom post type for locations
│   └── taxonomies/
│       ├── ays-taxonomy-service-type.php  # Taxonomy for service types
│       └── ays-taxonomy-price-range.php   # Taxonomy for price ranges
├── assets/
│   ├── css/                          # Stylesheets
│   └── js/                           # JavaScript files
├── templates/
│   └── form.php                      # Template for lead generation form
├── ays.php                           # Main plugin file

<<<<<<< Updated upstream

<<<<<<< Updated upstream

Stashed changes

=======

Stashed changes

Customization

To tailor the plugin to your business needs:

• Adjust the custom post types and taxonomies in the services directory.
• Customize pricing models for services like Service Professionals or similar service-related classes.
• Modify form layouts and styles by editing the form templates located in /templates/form.php.

<<<<<<< Updated upstream <<<<<<< Updated upstream

=======

=======

Stashed changes

WordPress.org Preparation

Project Studios is planning to submit the plugin to WordPress.org. Please ensure the repository adheres to WordPress plugin directory guidelines.

Recommended Tools

• Poedit: For managing translation files.
• WP CLI: For plugin activation, setup, and management from the command line.
• WP scripts: For task automation such as minifying CSS/JS or linting.
• Npm init automation: For additional task automation if needed.

License

The At Your Service Plugin is licensed under GPL v2 or later.

Future Roadmap

Planned features for upcoming versions:

• Advanced CRM Integration: With support for multiple customer types and sales funnel tracking.
• Subscription Services: Handling recurring services and automatic invoicing.
• Franchise Management: For businesses managing multiple locations or franchises.

Credits

At Your Service is developed and maintained by Shaun Palmer of Project Studios Web Agency, evolving with input from the service-based business community. <<<<<<< Updated upstream <<<<<<< Updated upstream

=======

======= Stashed changes