Consigna Quickstart, as shipped in the download

CONSIGNA — QUICKSTART
=====================
Consignment & Resale-Shop Manager — self-hosted PHP + MySQL/SQLite.

REQUIREMENTS
------------
  - PHP 8.0+ with extensions: pdo, pdo_sqlite (or pdo_mysql)
  - MySQL 5.7+ OR SQLite 3 (SQLite requires no extra setup)
  - A web server (Apache with mod_rewrite, or Nginx with try_files)


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/consigna/).

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

3. Visit your site in a browser. The installer opens automatically at
     https://yourdomain.com/install/

4. Choose your database:
     - MySQL: create a database + user in cPanel first, enter the credentials.
     - SQLite: nothing to create; the database file lives in data/.

5. Enter your shop name, currency symbol, default split, and admin account.
   Click "Install Consigna" — you land on the login page. Done.


LOCAL / DOCKER
--------------
Run locally with PHP's built-in server:

    cd app
    php -S 127.0.0.1:8080 router.php

or with Docker (Apache + PHP 8.3):

    cd app
    docker build -t consigna .
    docker run -p 8080:80 consigna

then open http://127.0.0.1:8080 and follow the installer.


DEMO DATA
---------
After installing, use "Load demo data" on the dashboard to fill the shop with
realistic consignors, items, sales, and payouts. "Reset all data" clears it
(your login and settings are kept).


FIRST STEPS
-----------
1. Settings — set your shop name, currency, default split, expiry days, timezone.
2. Add a consignor (their default split in basis points: 6000 = they get 60%).
3. Item intake — the SKU is auto-suggested; set list price and expiry.
4. When it sells: Items -> Sell -> enter the actual sale price. The split is
   computed penny-exactly and locked onto the sale.
5. Pay the consignor from their page — the app refuses to over-pay a balance.
6. Print a statement: Consignors -> Statement -> pick the date range ->
   "Print / Save as PDF", or download the CSV.


TROUBLESHOOTING
---------------
- 404s on every page but the dashboard: enable mod_rewrite / AllowOverride All,
  or mirror the .htaccess rules in your server config.
- "Could not write config.php": make the app folder writable during install,
  or copy config.sample.php to config.php and fill it in manually.
- Blank page: check your PHP error log; Consigna requires PHP 8.0+.

Support: see README.md.


NEW IN 2.0
----------
  * REST API + signed webhooks .... "API & Webhooks" in the sidebar; see API.md
  * Two-factor authentication ..... "Security" in the sidebar
  * Import consignors + items ..... "Import CSV" — dry run first, nothing written
                                    until you confirm
  * Payout / sale notifications ... Settings -> Email notifications (your own SMTP)
  * One-click backup .............. Security -> Backups (JSON, plus the raw DB on SQLite)
  * Dark mode ..................... the "Theme" toggle at the bottom of the sidebar
  * Uptime ping ................... GET /healthz  (no login required)

  Upgrading from 1.x: overwrite the app files and open the site once. The new tables
  and columns are added automatically; your data is untouched. Back up first anyway.