From ec41382f9d0cb21c1f7148142bc495a6a5ddd592 Mon Sep 17 00:00:00 2001 From: dogeystamp Date: Sun, 30 Apr 2023 20:54:26 -0400 Subject: [PATCH] README.md: added extra info --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 6da25b8..6d825f2 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,12 @@ source venv/bin/activate python -m pip3 install -r requirements.txt ``` +Create a configuration file (and set the secret key!) +``` +cp config.yml.example config.yml +vim config.yml +``` + Start Flask in development mode: ``` @@ -42,3 +48,17 @@ Please use the linter before submitting code. ``` black . ``` + +## database maintenance + +To clean up the database (remove stale entries): + +``` +flask --app sachet.server cleanup +``` + +Otherwise, to upgrade the database after a schema change: + +``` +flask --app sachet.server db upgrade +```