Skip to content

PHACDataHub/phac-django-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Django docs, tips and conventions

This a repo of docs for django projects.

  1. Github workflow
  2. conventions/advice for building and coding
  3. Typical structure of a project
  4. Configuring local-development environments

documentation TODOs:

  • how to install python3.10 on windows
  • how we use pytest, fixtures, etc.
  • how we do text and translation
  • how we should use django-versionator and how to use it to create changelogs
  • how to treat "" vs null for char/text fields
  • formsets vs htmx dynamic lists
  • modal pattern
  • solutions to N+1 queries
  • scripts vs data-migrations
  • authorization rules
  • graphql? Can just link to this for now
  • convert this list into github issues

Code TODOs:

  • Create a template repo
  • Extract some things into the helpers repo
    • custom model fields
    • export-utils
    • data-fetcher abstraction (clean up API first)
  • Do something about versionator. Maybe fork it under PHAC org so others can add features.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published