Revup Quickstart, as shipped in the download

REVUP — QUICKSTART
==================

REQUIREMENTS
------------
  - PHP 8.1+ (tested on 8.3) with extensions: pdo, pdo_sqlite (or pdo_mysql), curl
  - MySQL 5.7+ OR SQLite 3 (SQLite requires no extra setup)
  - A web server (Apache with mod_rewrite, or Nginx with try_files)
  - Optional: SMTP credentials (email sending) and/or Twilio (SMS sending).
    Without either, Revup runs in manual link-copy mode.

SHARED HOSTING / CPANEL (RECOMMENDED FOR MOST BUYERS)
------------------------------------------------------
1. Upload the contents of the `app/` folder to your web root (e.g. public_html/)
   or a subdirectory (e.g. public_html/revup/).

2. Make sure the data/ directory is writable by PHP.
   Via cPanel File Manager: right-click -> Permissions -> 755 or 775.

3. Visit https://yourdomain.com/install/ in your browser.

4. Fill in the installer:
     - Database: MySQL (host/name/user/pass) or SQLite (no setup)
     - Business name and your public review URL (can be set later)
     - Admin email + password

5. The installer writes config.php and redirects you to the login page.

6. Log in -> Settings:
     - Review destination URL(s) and the private-message threshold
     - SMTP block (email) and/or Twilio block (SMS) — both optional

7. Add a few contacts, create a campaign, create requests, send.


VPS / SELF-HOSTED
-----------------
Apache example:

  <VirtualHost *:80>
    DocumentRoot /var/www/revup/app
    <Directory /var/www/revup/app>
      AllowOverride All
      Require all granted
    </Directory>
  </VirtualHost>

Run the web installer as above, or use the CLI seeder for a demo database:

  php bin/demo.php    # loads demo data (login: admin@revup.app / admin123)


DOCKER (QUICK TEST)
-------------------
  docker run --rm -p 8080:8080 \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    php:8.3-cli \
    php -S 0.0.0.0:8080 router.php

  Then visit http://localhost:8080/install/


SENDING MODES
-------------
  * MANUAL (default): requests stay "pending"; copy each personal rating
    link from the Requests screen into any channel you like.
  * EMAIL: fill the SMTP block in Settings (host, port, encryption, user,
    password, from address). Any standard SMTP server works.
  * SMS: fill the Twilio block in Settings (Account SID, auth token, from
    number in E.164 format, e.g. +15551234567).

  Credentials are write-only: the settings form never displays them again.


THE RATING PAGE
---------------
  Each request link (yourdomain.com/r/<token>) asks for 1-5 stars, once.
  Every customer who rates is then shown your public review URL(s),
  whatever the rating. Ratings below the threshold (default 4) are ALSO
  offered a private message to you, below the review link - never instead
  of it. The message lands in your Feedback inbox and is never published.

  PLATFORM POLICY NOTE: Google's policy for Maps reviews lists "selectively
  solicit positive reviews from customers" as prohibited (read 2026-09-24),
  which is why every rater sees the review link. Choose "Do not offer a
  private message" in Settings to show the review link alone.


POST-INSTALL SECURITY CHECKLIST
--------------------------------
  [ ] config.php is protected (the .htaccess does this automatically)
  [ ] data/ is not web-accessible (.htaccess blocks it automatically)
  [ ] Use HTTPS in production (rating links carry tokens)
  [ ] Keep PHP updated