Skip to content

Commit

Permalink
tweaks readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
birkin committed Sep 23, 2024
1 parent 0629904 commit 7dbaa1d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,15 @@ Next -- well, the sky's the limit!
# nice features/practices

- Nothing private is in the project-repo; avoids using the `.gitignore` for security.
- Shows pattern to keep views.py functions short-ish, to act as manager functions (eg `views.version()`).
- Shows pattern to keep `views.py` functions short-ish, to act as manager functions (eg `views.version()`).
- Shows pattern to expose the data used by the page via adding `?format=json` (eg `views.info()`). Useful for developing the front-end and troubleshooting.
- Log-formatting shows useful stuff.
- Git branch/commit url is constructed in a way that avoids the new git `dubious ownership` error.
- Includes a couple of client-get tests that respond differentially to dev and prod settings.
- Includes a dev-only error-check url (enables confirmation that email-admins-on-error is set up correctly).
- Uses python-dotenv.
- Uses tilde-comparators in the `.in` requirements files for stable upgrades.
- Uses layered `base.in` and `server.in` requirements files which will produce `.txt` files, for clarity re what's really in the venv.
- Uses layered `base.in` and `server.in` requirements files which will produce `.txt` files -- for clarity re what's really in the venv.
- Specifies compatible package versions for reliable staging and prod deployment.
- Shows one possible pattern to make async calls (`app/lib/version_helper.manage_git_calls()`) and gather together the results.
- This webapp doesn't access the db much, but if it did, and you wanted to inspect the sql generated by the ORM, uncomment out the `django.db.backends` logger in `settings.py`.
Expand Down

0 comments on commit 7dbaa1d

Please sign in to comment.