How eitchtee/wygiwyh works
Project type and purpose
• Full‑stack single‑code‑base web application
• Opinionated finance tracker with multi‑currency support, DCA tracker, rules engine, and API.
• Backend: Django (with DRF, HTMX, Hyperscript), Procrastinate for async tasks
• Frontend: Webpack bundle (Bootstrap, Tailwind, Alpine.js)
File structure
• Top level:
– app/ (Django project and ~15 Django “apps” like accounts, transactions, currencies, import_app, export_app, etc.)
– frontend/ (Webpack config, src application scripts, styles)
– docker‑compose.dev.yml & prod (containers for Django web, Procrastinate worker, Supervisord, Webpack builder)
– requirements.txt (Python dependencies)
• Key configs: app/WYGIWYH/settings.py, docker/*, frontend/webpack/*.js
• Background tasks: app/apps/**/tasks.py, app/apps/rules/signals.py
• API layer: app/apps/api (DRF serializers, views, URLs)
README for additional insights
• Built with Django, HTMX, Procrastinate, DRF, Webpack, PostgreSQL
• Dockerized for prod/dev, environment variables for DB, secrets, feature flags
• Web UI + Automation‑ready API + scheduled background jobs (exchange rate fetcher, imports/exports)
Main components and interactions
a. Frontend (Browser & Static assets)
– Browser UI: HTML templates (Django + HTMX snippets) + JavaScript (webpack‑bundled scripts: htmx, hyperscript, jQuery, datepicker, etc.) + CSS (Bootstrap, Tailwind)
– Sends HTTP/HTMX requests to Backend
b. Django Web Server
– WSGI/ASGI app (app/WYGIWYH/wsgi.py & asgi.py)
– URL router → Django apps (views, DRF APIView)
– Templates → dynamic HTML + HTMX fragments
– Orchestrates business logic, form processing, rules engine
– Enqueues background jobs (via Procrastinate client)
c. PostgreSQL Database
– Stores users, accounts, transactions, currencies, DCA strategies, rules, import/export profiles, translations, etc.
– Django ORM / SQL queries
d. Background Worker (Procrastinate)
– Listens for enqueued jobs: exchange rate fetcher, import/app tasks, export tasks, recurring transaction generation, cleanup soft‑deleted transactions
– Runs scheduled jobs (cron‑like)
e. External Services
– Exchange rate providers (in app/apps/currencies/exchange_rates/providers.py)
– Translation service for localization (HerokuTranslate or similar)
– Optional integrations via API
Architectural patterns & design principles
• Monolithic MVC pattern (Django apps as modules)
• Separation of concerns:
– “apps/api” provides REST endpoints for automation
– “apps/common” holds shared utils, middleware, custom fields
– Each domain feature (accounts, transactions, rules, DCA, insights) in its own app
• HTMX/hyperscript for progressive enhancement—partial views and in‑page interactions
• Asynchronous task queue (Procrastinate) for long‑running or scheduled jobs
• Containerized micro‑services approach: Web, Worker, Build, Supervisord
Final checklist
[ ] Components labeled (Browser, Frontend Assets, Django Web, DB, Worker, External APIs)
[ ] Groupings for domain apps vs. shared/common code
[ ] Note key technologies next to each component (e.g., “Django + DRF + HTMX”)