forked from mahdahar/crm-summit
1.3 KiB
1.3 KiB
Project Overview
- Purpose: A CodeIgniter 4–based starter app tailored for the crm-summit domain (users, vendors, activities, products, guides) that builds on the official CI4 app starter. It exposes controllers/views for CRM-style operations and runs behind the
public/index.phpentrypoint. - Tech stack: PHP 8.1+, CodeIgniter 4 framework, Composer-managed packages (dompdf, endroid/qr-code, ramsey/uuid, Faker, vfsStream, PHPUnit 10+), PHPUnit for tests, and the
sparkCLI for maintenance/migrations. - Structure:
app/hosts Controllers, Models, Views, and Config;public/holdsindex.php, assets, and TinyMCE assets;tests/contains unit suites;vendor/holds Composer deps;writable/stores runtime files;.envcontrols environment settings. - Entry points:
public/index.phpfor web access,php spark servefor the dev server, andphp sparkcommands (cache:clear,migrate,migrate:rollback, etc.) for maintenance. - Environment: targeted for Windows development (CMD/PowerShell) but otherwise standard PHP/CI4 setup; make sure PHP 8.1+ extensions (intl, mbstring, json, mysqlnd, libcurl) are enabled.
- Key docs: README for high-level setup,
tests/README.mdfor testing guidance, and the rootAGENTS.mdfor style conventions and tooling commands.