summaryrefslogtreecommitdiff
path: root/README.mediawiki
diff options
context:
space:
mode:
authorAlon Levy <alon@pobox.com>2015-01-13 08:36:01 +0200
committerAlon Levy <alon@pobox.com>2015-01-13 10:24:00 +0200
commiteced38bfff26a9c7faf78683fe15f148732cd9cf (patch)
tree452466fa7c2923702df73fd2546da94b149d9925 /README.mediawiki
parent96534de0c0dceefde8795e879927c5bedbdaa858 (diff)
incorporate https://github.com/ivoviz/feedback
allows user to mark an image and send it. sends an email to configured recipient. defaults to using localhost:25 as the SMTP server (no user name, no password, see [1] for configuration parameters of flask-mail). Introduces a config parameter: FEEDBACK_RECIPIENT = feedback@localhost left TODO: 1. customize the 'thank you' text 2. document in user guide (setting MAIL_DEFAULT_SENDER correctly) [1] https://pythonhosted.org/Flask-Mail/#configuring-flask-mail
Diffstat (limited to 'README.mediawiki')
-rw-r--r--README.mediawiki25
1 files changed, 20 insertions, 5 deletions
diff --git a/README.mediawiki b/README.mediawiki
index 25bc6433..37f7dca3 100644
--- a/README.mediawiki
+++ b/README.mediawiki
@@ -14,14 +14,29 @@ A collaborative editor for organizing, communicating, and analyzing data in grap
= Use =
== requirements ==
+=== Server ===
+==== neo4j ====
Install [neo4j](http://neo4j.com/download/)
-Install [gevent-socketio](https://pypi.python.org/pypi/gevent-socketio/) Or <code> Run pip install gevent-socketio </code>
+==== python libs ====
+Install all of:
+# [gevent-socketio](https://pypi.python.org/pypi/gevent-socketio/)
+# [flask](http://flask.pocoo.org/)
+# [flask-mail](https://github.com/mattupstate/flask-mail)
-Install [simplejson](http://undefined.org/python/#simplejson) Or <code> Run pip install simplejson </code>
- - flask uses itsdangerous which uses simplejson
- - the default json converts namedtuples to arrays stripping the names.
- - simplejson converts them to a dictionary, a behavior we rely on.
+Or install it all via pip:
+<code>
+ pip install gevent-socketio
+ pip install flask
+ pip install flask-mail
+</code>
+
+=== Client ===
+All of the following are already bundled but noted here for reference:
+# [feedback](https://github.com/ivoviz/feedback) (it also bundles [html2canvas](http://html2canvas.hertzen.com/))
+# jquery
+# d3
+# FileSaver
== Running Rhizi Locally ==
To run Rhizi locally: