How hmmkez/tipiganan-backend works
TIPIGANAN is a Laravel REST API for an online repository of special and rare collections. Readers search and access theses, while staff manage thesis files, users, school-roster imports, citations and favorites; reporting and audit exports support administration. The sampled code confirms thesis OCR dispatch and extraction, roster synchronization, and cached reporting. The README also documents optional Meilisearch and Redis, plus audit and PDF report exports. Some controller and integration behavior is unsampled, so uncertain links are omitted rather than inferred.
Main entry points: api.php API routing · Thesis.php Thesis records · ReportController.php Analytics and exports · ThesisController.php Thesis management
Components 24
API and accounts
- API routing
routes/api.php - Authentication
app/Http/Controllers/Api/AuthController.php - Account management
app/Http/Controllers/Api/UserController.php - User accounts
app/Models/User.php
Thesis repository
- Thesis management
app/Http/Controllers/Api/ThesisController.php - Thesis records
app/Models/Thesis.php - Thesis search
app/Http/Controllers/Api/SearchController.php - Search service
app/Services/SearchService.php - OCR job
app/Jobs/ProcessThesisOcr.php - OCR extraction
app/Services/OcrService.php - Node OCR script
ocr/extract.cjs - PDF watermarking
app/Services/WatermarkService.php - Citation records
app/Http/Controllers/Api/CitationController.php - Favorites
app/Http/Controllers/Api/FavoriteController.php
School directory
- Roster administration
app/Http/Controllers/Api/SchoolRosterController.php - Roster synchronization
app/Support/SchoolRoster.php - School directory
app/Support/SchoolDirectory/SchoolDirectory.php
Reports and audit
- Analytics and exports
app/Http/Controllers/Api/ReportController.php - Audit log API
app/Http/Controllers/Api/AuditLogController.php - Audit records
app/Models/AuditLog.php - Safe cache
app/Support/SafeCache.php
Other components
- API users
- Meilisearch
- School system
Connections 32
- API users → API routing: calls API
routes/api.php - API routing → Authentication: routes to
routes/api.php - API routing → Account management: routes to
routes/api.php - API routing → Thesis management: routes to
routes/api.php - API routing → Thesis search: routes to
routes/api.php - API routing → Roster administration: routes to
routes/api.php - API routing → Citation records: routes to
routes/api.php - API routing → Favorites: routes to
routes/api.php - API routing → Analytics and exports: routes to
routes/api.php - API routing → Audit log API: routes to
routes/api.php - Account management → User accounts: updates accounts
app/Http/Controllers/Api/UserController.php - Account management → Audit records: records changes
app/Http/Controllers/Api/UserController.php - Thesis management → Thesis records: manages records
app/Http/Controllers/Api/ThesisController.php - Thesis management → OCR job: dispatches OCR
app/Http/Controllers/Api/ThesisController.php - OCR job → OCR extraction: calls extraction
app/Jobs/ProcessThesisOcr.php - OCR job → Thesis records: updates record
app/Jobs/ProcessThesisOcr.php - OCR extraction → Node OCR script: runs script
app/Services/OcrService.php - Thesis management → PDF watermarking: uses watermark
app/Http/Controllers/Api/ThesisController.php - Thesis search → Search service: delegates search
- Search service → Thesis records: searches records
app/Services/SearchService.php - Search service → Meilisearch: optionally indexes
README.md - Roster administration → Roster synchronization: imports roster
app/Http/Controllers/Api/SchoolRosterController.php - Roster synchronization → User accounts: updates accounts
app/Support/SchoolRoster.php - Roster administration → School directory: selects directory
- School directory → School system: checks membership
- Citation records → Thesis records: records citations
- Favorites → Thesis records: stores favorites
- Analytics and exports → Thesis records: reads metrics
app/Http/Controllers/Api/ReportController.php - Analytics and exports → User accounts: reads accounts
app/Http/Controllers/Api/ReportController.php - Analytics and exports → Audit records: reads activity
app/Http/Controllers/Api/ReportController.php - Analytics and exports → Safe cache: caches results
app/Http/Controllers/Api/ReportController.php - Audit log API → Audit records: exports records