How nicorenard/visiopompe works
Project type and purpose
• This is a full-stack, monolithic Django web application (“Visiopompe”) for managing a fleet of mechanical pumps and related maintenance equipment.
• It uses Django’s MVC (MVT) pattern for the backend, W3.css for frontend styling, MariaDB (or SQLite by default) for persistence, served via Apache + mod_wsgi in production.
File structure
• Top-level:
• src/config: Django project settings, URL routing, WSGI/ASGI entry points
• src/pompe: Main Django app (models, views, templates, static assets, URL config)
• requirements-prod.txt / .env-example: production dependencies & environment variables
• documentations: Sphinx-based standalone docs (user & developer guides)
• Patterns:
• MVT: models.py, views.py, templates/…
• Static/media separation: static assets in src/pompe/static, user‐uploaded media under src/media
• Deployment: Apache 2 + mod_wsgi config lives outside but documented
• Database migrations in src/pompe/migrations
Key README insights
• Architecture: Apache serves HTTP, forwards to Django via WSGI; Django ORM → MariaDB
• Frontend: static CSS/JS resources, Django templates render pages
• Admin interface: built-in Django admin for import/export, superuser management
• Documentation: Sphinx site under documentations/ to be served or linked
Essential elements
• Don’t overcomplicate—include every Django subcomponent only as part of the WSGI app node
• How Sphinx docs are generated from documentations/ and can be hosted separately
• Environmental config (.env → settings.py) as a startup dependency