Skip to content

automatinginnovatingai/roofers-app

Repository files navigation

Roofers App – User Guide
====================================
Version: 1.1.0
Build Date: 2025-09-08

Welcome to the Automating Innovating AI Roofers App — a streamlined, secure, and intuitive tool
for managing roofing production workflows, crew payroll, material usage, task tracking, and data exports.

Key Features
------------
• Secure Login:
  - Encrypted password protection with industry‑standard hashing.

• Payroll Management:
  - Input and calculate daily or weekly roofing payroll with precision.
  - Calculate roofing task and material usage using:
      • Quantity × Pay Rate (e.g., 12 bundles × $8.50/bundle)
      • Per‑piece rates (e.g., 4 pipe boots × $12.00)
      • Hourly wage (e.g., 8 hours × $25.00)
      • Enter 0 in any quantity or rate field that does not apply
  - Add up to four crew members for each job.
  - Automatic pay splitting among listed workers.

• Crew Job Entry:
  Each roofing job entry will require:
      - First and last name of each crew member
      - Employee ID (if applicable)
      - Work hours and roofing job roles
      - Client name, property address, unit number, and roof area
      - Optional: Roofing task and material info such as:
        • Shingles installed (Architectural, 3‑Tab)
        • Underlayment (Synthetic, Felt)
        • Flashing, drip edge, ridge caps, starter strips
        • Repairs performed (e.g., pipe boot replacement, leak repair)
        • Materials used (bundles, rolls, LF items, vents, nails)

• Pay Week Entry & Auto Export
  This application streamlines the process of marking pay cycles and exporting enhanced Excel reports.
  • Set the start and end day of the payroll period using a fullscreen interface.
    Example: Start Day = Monday, End Day = Sunday
  • Payroll is exported automatically 2 days after the end day
  • Press Esc to exit fullscreen mode at any time
  • Authorization Required
    - Only verified sessions (secure login with salted + hashed credentials) can access this module
  • What Gets Exported
    - Weekly roofing payroll grouped by name or ID
    - Exported to Excel files saved monthly under:
      Documents/AIAI_Roofing_App/Payroll_Excels/YYYY-MM/Payroll_YYYY-MM.xlsx
    - Each worker gets a dedicated sheet labeled by week number
    - Totals are auto‑calculated
  • After export:
    - You’ll be asked if you’d like to open the workbook immediately
    - Excel must be installed to view reports
  Tip: Ensure pay data is complete before the scheduled export date (End Day + 2).

• Data Protection:
  - Automatic de‑duplication to prevent redundant entries.

• Reporting:
  - Clean Excel‑compatible CSV exports grouped by month/day.
  - Ability to customize export file names.

• Auto‑Updating:
  - Automatically checks for new app versions.

• Friendly Interface:
  - Designed for ease of use—no technical knowledge required!

System Requirements
-------------------
• Operating System: Windows 10 or later is required.
• Microsoft Excel must be installed to view reports.
• At least 900 MB of available local disk space is recommended:
    - Data is stored using the client's SQL Server Express or SQL Server Database.
    - Monthly Excel files are created with worksheets by day.

License Activation
------------------
This app requires a valid Gumroad license key to unlock full functionality.
• You will be prompted to enter your license key on first launch.
• The app verifies your key securely via Gumroad’s API.
• If the license is invalid or revoked, access will be restricted.
Note: Internet access is required for initial license validation.

Getting Started
---------------
1. Launch the app via the Roofers App icon.
2. Click 'Admin Registration' to create an account.
3. After registering, click 'Admin Login' to sign in.
4. Navigate to the Admin Interface.
5. Click 'Crew Worksheet' to begin logging job and payroll data.

Navigation & Exiting
---------------------
• Use the dashboard to access key modules.
• Click the 'Exit' button on any screen to close the app.

Tips
----
• Export data regularly to back up your records.
• Use strong admin credentials.
• Keep Excel updated for full report compatibility.

Troubleshooting
---------------
• App won’t launch: Ensure Windows 10+ is installed and Excel is available.
• License key rejected: Double‑check your Gumroad purchase email.
• Export failed: Confirm pay data is complete and Excel is installed.
• Auto‑update not working: Check your internet connection and firewall settings.

Support
-------
Questions or feedback? Contact the developer:
automatinginnovatingai@outlook.com

Thank you for using the Roofers App!