From e11f04342a7d033d46973e7483c4ad7ffc4d1afc Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Sun, 27 Sep 2020 11:12:38 -0700 Subject: [PATCH] Use nested
for the setup and run instructions. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b6e80de..896135e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Etiquette is unique because *the tags themselves are hierarchical*. By tagging o ### Setting up +
Click to view setup instructions I have not made a setup.py yet. So I use a filesystem junction / symlink to make etiquette appear in my python lib folder.
Setting up via symlink @@ -27,8 +28,6 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make
---- -
Setting up via pythonpath - The repository you're looking at right now is `D:\Git\Etiquette`. The toplevel `etiquette` folder is the main package. @@ -44,10 +43,12 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make To make it permanent, add the export to your bashrc.
+
### Running -
Running locally +
Click to view run instructions +
Running Flask locally - Run `python etiquette_flask_launch.py [port]` to launch the flask server. Port defaults to 5000 if not provided. - Run `python -i etiquette_repl_launch.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`. @@ -61,9 +62,7 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make
---- - -
Running with Gunicorn +
Running Flask with Gunicorn 1. Use the PYTHONPATH technique to make `etiquette` and the flask `backend` both importable. Symlinking into the lib is not as convenient here because the server relies on the static files and jinja templates relative to the code's location. @@ -76,6 +75,7 @@ I have not made a setup.py yet. So I use a filesystem junction / symlink to make gunicorn etiquette_flask_entrypoint:site --bind "0.0.0.0:PORT" --access-logfile "-"
+
### Project stability