crm-summit/.serena/memories/crm-summit/project_overview.md

1.3 KiB
Raw Blame History

Project Overview

  • Purpose: A CodeIgniter 4based 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.php entrypoint.
  • 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 spark CLI for maintenance/migrations.
  • Structure: app/ hosts Controllers, Models, Views, and Config; public/ holds index.php, assets, and TinyMCE assets; tests/ contains unit suites; vendor/ holds Composer deps; writable/ stores runtime files; .env controls environment settings.
  • Entry points: public/index.php for web access, php spark serve for the dev server, and php spark commands (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.md for testing guidance, and the root AGENTS.md for style conventions and tooling commands.