Virteom Tools (tools.virteom.com)

Getting Started

Getting Started

Introduction

This documentation outlines how to build a new tool using the tools.virteom.com system and explains how the system is structured and maintained.

 

Tutorial Video

 

Homepage Overview

  • The homepage displays a list of all created tools.

  • Tools are filtered and displayed using the Isotope JavaScript Library.

  • Each tool includes data such as:

    • Author

    • Version

    • Tags/filters (e.g., “Google Ads”)

  • Tags must be spelled consistently to be grouped together correctly.

User and Client Management

Adding a User

  • Users can be added by clicking Add User.

  • Create a username and a password (hashed for security).

Adding a Client

  • Click Add Client.

  • Required fields:

    • Domain (e.g., virteom.com, no https:// prefix)

    • CMS type

  • Optional fields:

    • CallRail Company ID (no hyphens)

    • Google Ads Account ID

    • Google Analytics ID

Primary contact ID and contacts management are forthcoming features.

Creating a New Tool

Steps to Create

  1. Navigate to Manage Tools.

  2. Use the Upload Tool section to upload a .zip containing:

    • index.php

    • info.xml

  3. Alternatively, download an example template to modify.

  4. Extract and rename folder before use.

Tool Structure

  • Required Files:

    • index.php – Main script logic.

    • info.xml – Metadata.

Required Elements in index.php

  • Login Check (required when internal tool):

include_once($_SERVER['DOCUMENT_ROOT'] . '/global/login-check.php');

  • Header (recommended for usability):

include_once($_SERVER['DOCUMENT_ROOT'] . '/global/header.php');

  • Global Styles (optional):

<link rel="stylesheet" href="/styles/global-style.css">

CSS Defaults in global-style.css

  • Virteom color scheme

  • 1100px centered layout (same as our WordPress BeaverBuilder sites)

  • Basic padding and font family

info.xml Format

<tool>
  <title>Demo Tool</title>
  <description>Hello everyone</description>
  <author>Austin Carbone</author>
  <version>1.0</version>
  <created>June 19, 2025</created>
  <classes>
    <class>Reporting</class>
    <class>Google Ads</class>
  </classes>
</tool>

 

Where to Run Composer

  • Run Composer from the document root (/SITE-TOOLS-VIRTEOM/).

  • Composer packages will be available globally for all tools.

Uploading and Downloading Tools

  • Use the Manage Tools section to:

    • Upload zipped tools

    • Download installed tools for local development reuse

Config File Overview

  • Stores API keys (ChatGPT, Twilio, Google Ads, etc.)

  • Contains local and production DB credentials

  • Detects environment (local vs. production)

  • Sets up Database calls

Future Improvements

  • Manage Users / Clients / Contacts via UI

  • Mark tools as deleted (rather than immediate removal)

  • Restore or auto-delete after time expiration

Summary

  • The tool-building system is lightweight, modular, and PHP-based.

  • Emphasis on reusability, clarity, and security.

  • Can serve mockups or fully functional utilities efficiently.

For further improvements, refer to the respective PHP files and shared resources located within the global/ folder.