How herchila/cride works
Project type and purpose
• This is a Django-based, invite-only carpooling platform (“Comparte Ride”) exposing a REST API (via Django REST Framework) and sending email notifications.
• It uses Celery for background jobs (task processing, periodic tasks, monitoring via Flower), PostgreSQL for persistence, and Docker Compose for local/production deployments with Caddy as a reverse proxy.
File structure
• Top-level:
• manage.py, config/ (Django settings, URLs, WSGI)
• cride/ (Django apps: users, circles, rides, shared utils, templates, Celery config)
• compose/ (environment-specific Dockerfiles & startup scripts)
• local.yml & production.yml (Compose definitions)
• requirements/ (pip requirements per environment)
• Inside cride/:
• taskapp/ sets up Celery (“worker,” “beat,” “flower”)
• modular apps (users, circles, rides) each with models, serializers, views, permissions
• templates for transactional emails
• Environment separation:
• config/settings/{base,local,production,test}.py
• Docker Compose splits services for local vs. production (adds Caddy & maintenance scripts for Postgres)
Key insights from README
• Minimal description: group-bounded, invite-only carpooling
• No built-in frontend; likely mobile or SPA clients consume the API