# Quick

> Quick is a PHP Composer library that provides config management, database (MySQL), cache (Memcache/Redis), admin UI, API layer, and build/deploy scripts for web applications. It is not a standalone app—consumer projects add `kickiniteasy/quick` as a dependency and use it from `vendor/kickiniteasy/quick/`.

## Key Concepts

- **Library layout:** Quick lives in `vendor/kickiniteasy/quick/`. Consumer projects override `src/config/`, `src/admin/`, etc. Config is JSON (`config.{env}.json`) plus `.env` for secrets.
- **Autoload (PSR-4):** Inside the package, Composer maps `Quick\` → `src/Quick/`, `Staticsite\` → `src/Staticsite/`. Global classes `Quick`, `Staticsite`, and `Subdataobject` load via Composer `files` (see `composer.json`).
- **Entry point:** `quick()` or `Quick::instance()` gives access to config, db, cache, and registered packages. The Quick class is instantiated once per PHP process.
- **Dataobjects:** ORM classes extending `\Quick\Dataobject` with `$_columns` (DB) and `$_blob` (JSON in one column). Admin controllers extend `ControllerDataobject`. Hybrid model: columns are indexed and queryable; blob is flexible JSON in a single `data` column (schema evolution without migrations). Supports MySQL and PostgreSQL (`db.driver`).
- **Scripts:** `main.sh` routes to install, build, deploy, staticsite. Run via `bash vendor/kickiniteasy/quick/scripts/main.sh <command> <env>`.
- **Staticsite:** Built-in package for static-site build, S3 push, templates. Enable with `config.packages.staticsite = "Staticsite"`.

## Docs

- [For AI Assistants](docs/for-ai-assistants.md): Conventions, gotchas, common tasks (add Dataobject, add config, fix template vars), file locations table—start here
- [Architecture](docs/architecture.md): Directory structure, core classes (Quick, Config, Mainobject, Dataobject), request flow, file resolution
- [Configuration](docs/configuration.md): Config sections, loading order, `.env` QUICK_* vars, access patterns
- [Docker](docs/docker.md): Platform dev (this repo) vs consumer project Docker, compose files, hosts
- [Admin](docs/admin.md): URL routing, controllers in `controller/`, templates, `admin.navigation` config
- [Dataobjects](docs/dataobjects.md): Hybrid column+blob model, columns vs blob, create/edit, getByQuery, install.dataobject.php, MySQL/Postgres
- [Scripts](docs/scripts.md): main.sh, install.sh, build.sh, vhost.sh, deploy
- [API](docs/api.md): API entry point, authentication, actions
- [S3 Upload](docs/s3-upload.md): Direct-to-S3 uploads via presigned URLs

## Optional

- [README](README.md): Project overview, quick start, doc index
- [Docker platform](docker/README.md): Developing Quick itself with Docker
- [Docker project templates](docker/templates/README.project.md): Consumer project Docker setup