ID

85163f1

date

2022-10-16 19:37:05+00:00

author

Alex Chan <alex@alexwlchan.net>

parents

195dbe5, 4fc9024

message

Merge pull request #15 from alexwlchan/add-webapp-readme

Add some instructions on installing the app

changed files

2 files, 24 additions, 1 deletion

• webapp/README.md
• webapp/server.py

Changed files

webapp/README.md (1298) → webapp/README.md (1822)

diff --git a/webapp/README.md b/webapp/README.md
index c7bd61f..25fc6c8 100644
--- a/webapp/README.md
+++ b/webapp/README.md
@@ -21,3 +21,26 @@ I have to [compile MUSL libc-based versions][compile] of the CLI tool to get it 
 [Flask]: https://pypi.org/project/Flask/
 [Glitch]: https://glitch.com/
 [compile]: https://alexwlchan.net/2022/05/rust-on-glitch/
+
+
+
+## Development
+
+You should only need to run the web app for development; if you can install packages locally the CLI is probably a better option.
+
+1.  Install the [latest release] of the CLI
+2.  Install the Python requirements:
+
+    ```console
+    $ pip3 install -r requirements.txt
+    ```
+
+3.  Run the web server script:
+
+    ```console
+    $ python3 server.py
+    ```
+
+This will start a debug version of the web app at <http://localhost:4711>
+
+[latest release]: https://github.com/alexwlchan/dominant_colours/releases

webapp/server.py (3207) → webapp/server.py (3218)

diff --git a/webapp/server.py b/webapp/server.py
index 5e1bbb1..f2dfae9 100755
--- a/webapp/server.py
+++ b/webapp/server.py
@@ -117,4 +117,4 @@ def get_palette():
 
 
 if __name__ == "__main__":
-    app.run(debug=True, host="0.0.0.0")
+    app.run(debug=True, host="0.0.0.0", port=4711)