From 26663ce7a4bb75d2602261ed957bf3c1cdc4ebc6 Mon Sep 17 00:00:00 2001 From: Sam Ockman Date: Thu, 24 May 2012 03:10:30 -0400 Subject: Added README, modified requirements --- README-wqflask.txt | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README-wqflask.txt (limited to 'README-wqflask.txt') diff --git a/README-wqflask.txt b/README-wqflask.txt new file mode 100644 index 00000000..fdade7fa --- /dev/null +++ b/README-wqflask.txt @@ -0,0 +1,31 @@ +This readme concerns the directory wqflask - an officially sanctioned fork of the main GeneNetwork +code. It's still very early in the process - but we eventually want to port all of the code +in GeneNetwork to Flask and Jinja2. For more information about the project in general, see +the file README.md. + +For more information about the port to Flask, please keep reading. + +************************* + +Requirements: + +* Python 2.7 + +* virtualenv 1.7.1.2 or later + +* Other python dependencies are listed in the file wqflask/requirements.txt + +************************** + +Installation: + +We highly recommend you create a virtual enviornment called ve27 in your home directory. + +> cd ~ + +> virtualenv ve27 + +> source ~/ve27/bin/activate + +> pip install -r ~/gene/wqflask/requirements.txt +(Or replace gene with the name of the directory holding your repository) -- cgit v1.2.3 From 3912f2bacd87f607e9fdfa7a83fcdc05522589e0 Mon Sep 17 00:00:00 2001 From: Sam Ockman Date: Thu, 24 May 2012 03:28:38 -0400 Subject: Added more to readme --- README-wqflask.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README-wqflask.txt') diff --git a/README-wqflask.txt b/README-wqflask.txt index fdade7fa..03e3a1cc 100644 --- a/README-wqflask.txt +++ b/README-wqflask.txt @@ -21,11 +21,31 @@ Installation: We highly recommend you create a virtual enviornment called ve27 in your home directory. + +Get into your home directory > cd ~ +Create a virtual environment > virtualenv ve27 +Activate the environment > source ~/ve27/bin/activate +Install dependencies > pip install -r ~/gene/wqflask/requirements.txt (Or replace gene with the name of the directory holding your repository) + +************************** + +Running the program: + +Assuming your enviornment is activated (source ~/ve27/bin/activate) just run: + +> python ~/gene/wqflask/runserver.py + +The program as configured runs on port 5000 and does not serve static files. + +You'll have to run a webserver to serve pages on port 80 and to server the static files (or +flask could also be configured to serve the static pages). + +A sample configuration file for nginx is in the directory: wqflask/other_config/nginx.conf -- cgit v1.2.3