Skip to content

Deployment & Architecture Alignment #23

@JosePizarro3

Description

@JosePizarro3

@LucasZimm

This super-issue tracks all tasks required to align with institutional deployment standards and the cookiecutter-django template expectations.

GitHub will help us create sub-issues and track progress. We need to split responsibilities, so it is clear who does what.


🔥 High Priority (Must-Have)

  • Create separate dev and prod settings modules. @JosePizarro3
  • Add required production security settings (HTTPS, HSTS, secure cookies, proxy headers).
  • Add Dockerfile and minimal docker-compose setup for IT deployment. @JosePizarro3
  • Align database usage to institutional PostgreSQL version. @JosePizarro3

⚙️ Medium–High Priority (Important Enhancements)

  • Add/improve automated tests and ensure clean CI integration. @LucasZimm
  • Evaluate Celery for running parsing/upload tasks asynchronously. @LucasZimm
  • Integrate Sentry for centralized error monitoring. @JosePizarro3
  • Define standardized storage strategy for uploads/temporary files (tmp dir, S3/GCS/Azure/nginx if needed). @LucasZimm
  • Decide how to serve static files in production (Whitenoise vs cloud storage). @JosePizarro3 (tho I think this is done already with Whitenoise, we just need to clarify it in our docs)

🧩 Medium Priority (Structural or Workflow Improvements)

  • Add pre-commit hooks for lint and formatting checks. @JosePizarro3
  • Decide whether to introduce a custom Django User model for future-proofing. @JosePizarro3
  • Review and document static vs media separation in the project structure. @LucasZimm

🎨 Low Priority (Optional / Cosmetic / Future Considerations)

  • Decide whether to adopt Bootstrap v5 or keep minimal CSS. @JosePizarro3
  • Assess whether ASGI/WebSockets are needed for future live progress updates. @JosePizarro3
  • Evaluate whether a build pipeline (Gulp/Webpack) is necessary. @JosePizarro3 (likely not)
  • Consider using django-allauth only if institutional SSO requirements change. @JosePizarro3

💤 No Priority (Currently Not Needed, Tracked from the cookiecutter-django repo)

  • Add email support via Anymail (only if email notifications become needed).
  • Enable Mailpit for local email testing (only if emails are added).
  • Add Heroku Procfile (not relevant).
  • Add PythonAnywhere deployment docs (not relevant).

📌 Notes

Please keep all discussion related to deployment, architecture, and compatibility inside this issue.
Subtasks can be broken off into separate issues as needed, but keep this super-issue updated.

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions