How seed-platform/seed works
Frontend (User Interface)
• AngularJS application integrated with Bootstrap and additional JavaScript libraries.
• Static assets (under the “seed/static/seed” directory) that provide UI components, templates, partials, and client-side controllers.
• Optionally denote the Swagger API documentation avenue that is accessible via the UI or directly at a given endpoint (e.g., “/api/swagger”).
Backend (Web Application Layer)
• Django application housed in the “seed” module, which is organized into various submodules (e.g., for API endpoints, views, serializers, models, migrations, and Celery tasks).
• Separation of concerns (e.g., models, views, serializers, management commands, and API endpoints under “seed/views”, “seed/serializers”, “seed/models”, and “seed/api”).
• Extensive use of migrations and configurations in “config”, which helps manage environment-specific settings and URL routing.
Background Processing and Task Management
• Celery workers (triggered by scripts in the “bin” directory such as “start_celery.sh” and task definitions in “seed/tasks.py”) that handle asynchronous jobs (for data processing, file imports, etc.).
• If applicable, indicate any broker (usually Redis or RabbitMQ, even if not explicitly noted in the file tree) that Celery uses as an intermediary.
Database
• PostgreSQL database as the central data store.
Deployment and Infrastructure Components
• Docker components: Dockerfiles (“Dockerfile”, “Dockerfile-dev”, “Dockerfile.ecs”) and Docker Compose files (such as “docker-compose.yml”, “docker-compose.dev.yml”) that help in containerizing and orchestrating the system.
• External configuration for continuous integration (workflows in “.github/workflows”) and deployment scripts like “deploy.sh”.
External Interfaces and APIs
• RESTful APIs provided by the Django application, with endpoints grouped under “seed/api/v3” and “seed/api/v4”.
• Pointers for API consumers or developers (with the Swagger docs available at the proper endpoint).
• Use clear labels for each component (e.g., “AngularJS Frontend”, “Django Web Server”, “Celery Task Queue”, “PostgreSQL Database”).