How carlos-victor/marmitex works
Project type and purpose
• This is a Django-based REST API backend (“marmitex”) designed to expose menu data for “marmitárias” (meal-delivery kitchens).
• It does not include a frontend; instead it serves JSON over HTTP to consumers such as mobile apps or web frontends.
• CI/CD is orchestrated via GitHub Actions, with Docker/Herkou for containerized deployment.
File structure
• Top level:
• .github/workflows & .github/actions: CI pipelines for testing and deployment
• Dockerfile.heroku, docker-compose.yaml, heroku.yml: container build and cloud deployment config
• source/: contains the Django project (“marmitex”) and three apps: company, menu, utils
• Within source/:
• marmitex/: Django settings, URLs, ASGI/WSGI entrypoints
• company/, menu/, utils/: each is a Django app, with models, migrations, serializers, viewsets (menu), tests
• manage.py and requirements.txt
• There are no separate microservices—everything lives in a single Django process.
Main components
a. API Service
• Django application running Gunicorn or Uvicorn (ASGI) inside a Docker container
• Hosts the REST endpoints under URL patterns defined in marmitex/urls.py
b. Database
• A PostgreSQL instance (likely defined in docker-compose.yaml or via Heroku’s managed add-on)
c. Clients
• Mobile or web frontends (external HTTP clients)
d. CI/CD & Infrastructure
• GitHub Actions pipelines (build, test, deploy)
• Docker Registry (optional)
• Heroku or Docker host as production environment
e. (Optional) Cache or Message Broker
• If Redis or Celery is used, add as separate service (not present in file tree by default)
Relationships and data flow
• Clients → HTTP request → API Service
• API Service → ORM → Database
• API Service ← GitHub Actions → Docker build → Registry → Deploy to Heroku
• (If using migrations) API Service → run migrations → Database schema changes
Architectural patterns and design principles
• Django MVT (Model-View-Template) adapted for API (Model-Serializer-Viewset)
• Separation of concerns by splitting functionality into apps (company, menu, utils)
• Containerization for environment consistency
• Automated pipelines for CI (unit tests in ./tests) and CD (deploy on merge)
Relevant technologies, frameworks, libraries
• Python 3.x, Django, Django REST Framework
• Docker, Docker Compose, Heroku
• GitHub Actions
• PostgreSQL
• (Implicit) Gunicorn or Uvicorn