Add unittest for function first_of_month.

[chrisu/seepark.git] / web / README

diff --git a/web/README b/web/README
index aa14624ef39e10e4a1274f7c78d6f90265f6bfe6..0dd0ca6bc4a68e946556b09acd58c6c8fe7e5f9c 100644 (file)
--- a/web/README
+++ b/web/README
@@ -1,12 +1,47 @@
-Needed packages: python3-flask python3-sqlalchemy python3-mysqldb
+Needed packages: (python3-flask python3-sqlalchemy) python3-mysqldb python3-flask-sqlalchemy python3-sphinxcontrib.httpdomain
 
 Start with:
 FLASK_APP=seepark_web.py FLASK_DEBUG=1 SEEPARKINI=~/seewasser.ini flask run
 
+Option:
+-h 0.0.0.0
+at the end to listen on all interfaces, i.e.
+FLASK_APP=seepark_web.py FLASK_DEBUG=1 SEEPARKINI=~/seewasser.ini flask run -h 0.0.0.0
+(or :: instead of 0.0.0.0 for ipv4+ipv6)
+
+
 Go to:
 http://127.0.0.1:5000/
+or http://<ipaddress>:5000/
+if the app is running on a different machine
 
-Option:
--h 0.0.0.0
-to listen on all interfaces
+---
+
+notes on a "production" server:
+
+needed: python3-waitress
+
+run (in folder web):
+SEEPARKINI=~/seewasser.ini waitress-serve --port 8765 'seepark_web:app'
+
+links:
+
+http://flask.pocoo.org/docs/1.0/tutorial/deploy/
+http://flask.pocoo.org/docs/1.0/tutorial/factory/
+https://github.com/pallets/flask/blob/1.0.2/examples/tutorial/flaskr/__init__.py
+
+https://docs.pylonsproject.org/projects/waitress/en/latest/
+https://docs.pylonsproject.org/projects/waitress/en/latest/runner.html#runner
+
+https://gr33ndata.blogspot.com/2012/01/waitress-flask.html
+
+---
+
+Generate documentation:
+cd doc
+SEEPARKINI=~/seewasser.ini make web
+
+---
 
+Execute unittests
+SEEPARKINI=~/seewasser.ini python3 -m unittest seepark_web_tests.py