From 645913b7b6d51f62f16fef9d0461f7b8d830e4f6 Mon Sep 17 00:00:00 2001 From: PV Tejas Date: Tue, 11 Jul 2023 09:33:35 +0000 Subject: [PATCH] Add README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..419cfcb --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +## Development + +From the root directory, run `pip install -r requirements.txt` to install the package (and all dependencies) in editable mode. +Use `flask --app flaskr run` to run app. The package will be updated as you edit files. + +## Production +Run `python -m build --wheel` to generate the wheel, and install the wheel (found in `dist/`) in the production environment. +Use `flask --app flaskr run` to run app. To update package, you will need to install a new wheel. + +## Initializing database +The first time you install the app in each environment, you need to initialize database using `flask --app flaskr init-db`. This only needs to be run once per environment, and **will delete existing database if run again**.