From 5ea9469cc2169c0cd72ea2f5a05fc46f2ad39a9e Mon Sep 17 00:00:00 2001 From: sinavir Date: Sun, 9 Jun 2024 20:16:00 +0200 Subject: [PATCH] fix: Update readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a893bba..3be10e7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ # Djangonix ❄️ -Nix expression to declaratively deploy django applications +Nix expression to declaratively deploy django applications. + +## How it works + +The main issue for deploying declarative django applications is the pass secrets to the settings. + +This opinionated module tackles this issue by building an ad-hox settings +module that re-exports the settings.py from the app and overrides some settings +using the [loadcredential python module](https://github.com/Tom-Hubrecht/loadcredential). +The settings to be overriden are provided by the user through the module. + +With this you should be able to deploy almost any django application without any +modification of the `settings.py` file. ## Exemple @@ -16,4 +28,7 @@ nix-build test.nix ## TODO - Hardening +- Add a logic to change `INSTALLED_APPS` and `MIDDLEWARE` easily (the idea is to be able to remove developpement apps at no cost) +- Add test case for runtimeSettings (it is probably broken for now) +- Add test case for static assets - Remove all TODOs