aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 7500744..b5844f2 100644
--- a/readme.md
+++ b/readme.md
@@ -115,6 +115,13 @@ of annotated raw SQL queries, exposing them as callable Python functions.
115* `./sql/` 115* `./sql/`
116 * `tables.sql`: database initialisation statements 116 * `tables.sql`: database initialisation statements
117 * `queries.sql`: annotated SQL queries (from which the DAO is derived) 117 * `queries.sql`: annotated SQL queries (from which the DAO is derived)
118
119* `./app/`
120 * `app_database.py`: database connection pool and transaction helper
121 * `app_sessions.py`: (signed cookies) session data management helpers
122 * `app_{account,wallet}.py`: page-specific request handlers
123 * `app.py`: FastAPI web application entry point
124
118* `./flake.nix`: project runtime and development environment description 125* `./flake.nix`: project runtime and development environment description
119 126
120### Security considerations 127### Security considerations
@@ -196,6 +203,23 @@ before being created and initialised again:
196dropdb app 203dropdb app
197``` 204```
198 205
206### Local application server
207
208The server application can be started in development mode with:
209
210```sh
211uvicorn \
212 --reload-dir app \
213 --reload-dir templates \
214 --reload \
215 --app-dir app \
216 app:main
217```
218
219This server will listen to incoming requests to a locally bound port. It will
220automatically reload itself when its files are edited, and display logs about
221type checking and runtime errors.
222
199 223
200## Copyright and licensing 224## Copyright and licensing
201 225