ac-helper/README.md

1.8 KiB

Activation Calendar Helper

A web-based tool for managing marketing deliverables with AI-powered automation.

Features

  • AI Command Interface: Create and update deliverables using natural language (powered by Gemini).
  • Smart Spreadsheet: Interactive grid with sorting, filtering, and dependent dropdowns.
  • Multi-Sheet Support: Create, rename, duplicate, and delete multiple sheets.
  • Strict Data Hierarchy: Enforced 3-level dependency (Category -> Media -> Sub-media).
  • Export: Export data to CSV.
  • Secure: Server-side protection for sensitive files.

Installation

  1. Clone the repository:
    git clone git@bitbucket.org:zlalani/ac-helper.git
    
  2. Configure:
    • Ensure config.php is present with your $GEMINI_API_KEY.
    • Ensure the sheets/ directory is writable by the web server.
  3. Run:
    • Serve the application using a PHP server (e.g., Apache, Nginx, or php -S localhost:8000).

File Structure

  • index.php: Main application entry point.
  • api.php: Backend API handling commands and data operations.
  • script.js: Frontend logic (UI, API calls, Jspreadsheet integration).
  • style.css: Application styling.
  • sheet_helpers.php: Helper functions for file-based sheet management.
  • sheets/: Directory storing individual sheet JSON files.
  • sheets_metadata.json: Registry of all sheets.
  • config.php: Configuration and secrets (Excluded from git).
  • .htaccess: Security rules.

Security

  • .htaccess prevents direct access to:
    • config.php
    • sheet_helpers.php
    • *.json (Data files)
    • *.log (Log files)
    • README.md (Documentation)
    • Hidden files (starting with .)

Usage

See help.php (accessible via the "Help" button in the app) for user guide.