How shelterassociates/shelter works
Project type and purpose
• This is a full-stack, monolithic Django web application (“shelter” project) for data collection, mapping, reporting and analysis in urban slum contexts.
• It integrates GIS/KML parsing, form surveys (via KoBoToolbox/Avni), dashboards/graphs, and BIRT-based report generation.
File structure
• Top-level Django project:
• shelter/ – settings.py, urls.py, wsgi.py
• manage.py
• Six core Django apps, each encapsulating a domain:
• component – KML parsing, KoBo sync, form handling, APIs, cipher utilities
• master – slum mapping, GIS widget integration, Drupal data import
• graphs – data analysis, dashboard card generation, JSON mappings, sync scripts
• mastersheet – accounting/daily reporting sync, Excel export
• sponsor – sponsor management and BIRT fact-sheet integration
• filter – simple model/view filtering utilities
• DBScripts/ – PostgreSQL view definitions and SQL scripts
• ReportFile/ & reports/ – BIRT .rptdesign templates for fact sheets & reports
• deploy/ & scripts/ – shell and Python scripts for data sync (AVNI, KoBo), migrations, image compression, cron jobs
• static/ & templates/ – CSS/JS/images, HTML/Django templates for UI
• requirement.txt & package.json – Python and JS dependencies
README
• Confirms use of Python virtualenv, PostgreSQL, Django migrations, and runserver.
Detail
• Break out each Django app as a separate subcomponent, showing which scripts or templates it manages.
• How deploy/cron scripts trigger data ingestion into the DB.
• How BIRT templates map to DB views (DBScripts/) to generate reports.