How akzarma/enterpriseresourceplanning works
Project type and purpose
• This is a monolithic, full-stack ERP system built with Django.
• It provides a web interface (Django templates + static JS/CSS) and exposes APIs for a mobile (Android) client.
• Domain-specific Django apps encapsulate functions like Attendance, Registration, Exam, Timetable, Research, etc.
File structure
• Top-level “EnterpriseResourcePlanning/” directory:
• settings.py, urls.py, wsgi.py — the Django project entry point.
• manage.py — Django CLI.
• One Django app per feature under the root:
• Attendance, Registration, Exam, Feedback, Internship, Timetable, BackupRestore, Dashboard, Research, etc.
• Each app contains models.py, views.py, urls.py, templates/, static/ (where applicable), and migrations/.
• Supporting files:
• celerybeat-schedule & .pid — Celery periodic tasks.
• Sync/ — JSON cert and a function for data synchronization.
• Configuration/ — application-wide configs (countryConf.py, stateConf.py).
• templates/ at root: global base.html, alert.html, loading.css.
• requirements.txt, runtime.txt, Procfile — deployment descriptors (Heroku/Gunicorn).
README
• Confirms it’s an ERP system with both mobile (Android) and web interfaces.
Key components and interactions
a. Clients
• Web browser (HTML/CSS/JS)
• Android mobile app (consumes REST API endpoints)
b. Web Server Layer
• Django application
• URL router → App modules (Attendance, Registration, Exam, …)
• View logic → Templates (HTML) for web, JSON for mobile clients
• Configuration module (Configuration/countryConf.py, stateConf.py)
c. Data Layer
• Primary relational database (SQLite in development, likely Postgres/MySQL in production)
• Backup/Restore subsystem (BackupRestore app writes/reads .sqlite3 dumps)
d. Asynchronous/Task Layer
• Celery workers (tasks defined in Timetable/tasks.py and others)
• Message broker (e.g., Redis or RabbitMQ)
• celerybeat scheduler for periodic jobs (e.g., backups, notifications)
e. Static & Media
• Static files served via Django’s staticfiles (Dashboard/static/)
• Template files under each app and global templates/
f. External Services
• Email/SMS gateways for notifications (hinted by Dashboard notifications)
• Possible third-party APIs for Sync/function.py
Architectural patterns & principles
• MVC (Django’s MTV): models.py → templates/ → views.py
• Modular app decomposition: each business domain in its own Django app
• Asynchronous processing via Celery for long-running tasks (timetable generation, backups)
• Configuration-driven setup via Python modules (Configuration/)
• Separation of concerns: UI (templates/static), business logic (views/forms), data (models), integration (Sync, BackupRestore)
Detail
• Major Django apps as sub-components of the server.
• Celery beat scheduler as a timed trigger to Celery tasks.
• Global templates/ and static/ directories as part of the view layer.