How stevecode21/opencats_lawrence works
Project type and purpose
• This is a full-stack, monolithic PHP web application (OpenCATS) for applicant tracking.
• It exposes both traditional page views (via modules/*.tpl and UI PHP classes) and an AJAX API (ajax/*.php) to drive dynamic features (search, inline edits, lookups).
• It includes CLI/queue components (QueueCLI.php, modules/queue with tasks), scheduled scripts (scripts/…), and uses Sphinx for full-text search, MySQL for persistence, and filesystem storage for attachments.
File structure
Top-level components:
• web root: index.php, ajax/, modules/, js/, css/, attachments/
• core libraries and business logic: lib/
• modern PHP domain model & tests: src/OpenCATS/Entity + src/OpenCATS/UI + tests (unit & integration) + behat tests
• configuration: config.php, composer.json/lock, docker/ (Compose files), .travis.yml, CI scripts
• database schema & upgrades: db/
• search engine integration: lib/sphinx, optional-updates/latest-sphinx-search, scripts/sphinx_*
• background/queue: QueueCLI.php, modules/queue, scripts/…
• utilities & build scripts: scripts/, ci/, rebuild_old_docs.php
README for additional insights
• Confirms “free & open source candidate/applicant tracking system.”
• Key features: job posting → candidate application → selection/submission.
• No built-in distributed microservices—single PHP codebase with optional Docker containers for MySQL, PHP, Sphinx.
a. Main components:
1. Client (Browser / JS code / CSS)
2. Web server (Apache/Nginx + PHP-FPM) hosting index.php, ajax endpoints, module/UI classes, lib logic
3. MySQL database (schema in db/)
4. Sphinx search daemon (indices under lib/sphinx/index, config in lib/sphinx/conf)
5. File storage (attachments/ directory)
6. Queue/CLI worker (QueueCLI.php, modules/queue tasks) invoked via cron or CLI
7. External services: SMTP mail server, LDAP directory (lib/LDAP), 3rd-party XML feeds (wsdl/)
8. Docker orchestration (docker-compose.yml): brings up PHP, MySQL, Sphinx for dev/test
9. Test frameworks: SimpleTest (lib/simpletest), Behat (test/features)
b. Relationships and interactions:
• Browser → HTTP requests → Web server → PHP application
• Front-end pages rendered by modules/*.tpl + UI PHP classes
• Dynamic data via AJAX endpoints (ajax/*.php)
• PHP application → MySQL (via lib/DatabaseConnection, lib/DatabaseSearch)
• PHP application → Sphinx API (lib/sphinx/sphinxapi.php) for search queries
• PHP application → filesystem for attachments and temporary files
• PHP application → queue tasks (modules/queue, QueueCLI.php) for background jobs (email reminders, reports)
• CLI/cron → invoke QueueCLI.php → fetch tasks → PHP application logic → update DB/send emails
• Docker Compose network wires PHP, MySQL, Sphinx containers
• CI pipeline (.travis.yml, ci/) runs unit tests (src/OpenCATS/Tests), integration tests, Behat scenarios
c. Architectural patterns and design principles:
• Modular MVC-ish layering: modules/ directory groups UI + templates per domain area (candidates, companies, joborders, etc.).
• Core business logic in lib/ (service classes, utilities)
• Domain model under src/OpenCATS/Entity with repository pattern
• Separation of concerns: UI vs. business logic vs. data access vs. search
• Extension hooks (lib/Hooks) and plugin-style modules for optional components
• Asynchronous background processing via queue/CLI
d. Key technologies, frameworks, libraries:
• PHP (5.6+), Composer for autoloading
• MySQL (InnoDB)
• Sphinx Search
• SimpleTest + Behat for automated testing
• Artichow (PHP charting), FPDF (PDF generation)
• jQuery-style AJAX, custom JS modules in js/
• Docker Compose for development environment