update setup docs

docs/setup-linux.md

@@ -8,7 +8,13 @@ sudo apt-get install git
 sudo apt-get install python-dev python-pip virtualenv
 sudo apt-get install libxml2-dev libxslt-dev
 sudo apt-get install pandoc
-sudo apt-get install texlive                               # for pdf output
+
+# optional, for pdf output
+sudo apt-get install texlive
+
+# optional, to use bower to fetch front-end components
+sudo apt-get install nodejs nodejs-legacy npm
+npm -g install bower
 ```
 
 on RHEL/Centos use:
@@ -19,7 +25,13 @@ sudo yum install git
 sudo yum install python-devel python-pip python-virtualenv
 sudo yum install libxml2-devel libxslt-devel
 sudo yum install pandoc
-sudo yum install texlive                                   # for pdf output
+
+# optional, for pdf output
+sudo yum install texlive
+
+# optional, to use bower to fetch front-end components
+sudo yum install nodejs
+npm install -g bower
 ```
 
 Now, clone the repository to a convenient place:
@@ -58,3 +70,18 @@ Then, setup the application:
 ./manage.py migrate          # initializes the database
 ./manage.py createsuperuser  # creates the admin user
 ```
+
+Finally, install the front-end components. This can be done using bower:
+
+```
+python manage.py bower install
+```
+
+Alternatively, if node.js, npm and/or bower are not available or not wanted on the machine, download the components using `wget`:
+
+```
+wget -qO- https://github.com/rdmorganiser/rdmo-components/archive/master.tar.gz | tar xvz
+mv rdmo-components-master components_root
+```
+
+In both cases a `components_root/bower_components` containing various JavaScript and CSS libraries should be available.

docs/setup-osx.md

@@ -8,10 +8,14 @@ brew install python                                        # for python 2.7
 brew install python3                                       # for python 3.4
 brew install git
 brew install pandoc
-brew install textlive                                      # optional, for pdf export
-```
 
-(For the optional export to pdf, you need to install `pdflatex`, which you should install using [mactex](https://www.tug.org/mactex/)).
+# optional, for pdf export
+brew install textlive
+
+# optional, to use bower to fetch front-end components
+brew install node
+npm -g install bower
+```
 
 Now, clone the repository to a convenient place:
 
@@ -49,3 +53,18 @@ Then, setup the application:
 ./manage.py migrate          # initializes the database
 ./manage.py createsuperuser  # creates the admin user
 ```
+
+Finally, install the front-end components. This can be done using bower:
+
+```
+python manage.py bower install
+```
+
+Alternatively, if node.js, npm and/or bower are not available or not wanted on the machine, download the components using `wget`:
+
+```
+wget -qO- https://github.com/rdmorganiser/rdmo-components/archive/master.tar.gz | tar xvz
+mv rdmo-components-master components_root
+```
+
+In both cases a `components_root/bower_components` containing various JavaScript and CSS libraries should be available.

docs/setup-windows.md

@@ -1,39 +1,62 @@
 Setup RDMO on Windows
 ----------------------------
 
-Install the prerequisites from their webpages:
+First, install the following prerequisites:
 
-* `python` (we recommend version 3.4) from https://www.python.org/downloads/windows/
-* `git` from https://git-for-windows.github.io/
-* `Pandoc` from http://pandoc.org/installing.html
-* `pdflatex` (optional, for pdf export) from http://miktex.org/
+#### python
 
-The open the windows shell `cmd.exe` from  the Start-Menu.
+* from https://www.python.org/downloads/windows/
+* we recommend a version >= 3.4
+* don't forget to check 'Add Python to environment variables' during setup
 
-Now, clone the repository to a convenient place:
+#### git
+
+* from https://git-for-windows.github.io/
+
+#### C++ Build Tools
+
+* from http://landinghub.visualstudio.com/visual-cpp-build-tools
+
+#### pdflatex
+
+* optional, for pdf export
+* from http://miktex.org/
+
+#### node.js, npm, and bower
+
+* optional, only needed if you want to use bower to fetch the front-end components
+* from https://nodejs.org/en/download/
+* after the installation of node.js, install bower using `npm -g install bower` in `cmd.exe`.
+
+To begin with the RDMO setup, open the windows shell `cmd.exe` from the Start-Menu, change to a directory of you choice, and clone the repository:
 
 ```
 git clone https://github.com/rdmorganiser/rdmo
 ```
 
-Change to the created directory, create a [virtualenv](https://virtualenv.readthedocs.org) and install the required dependecies:
+Change to the created directory, create a [virtualenv](https://virtualenv.readthedocs.org) and install the required python dependencies:
 
 ```
 cd rdmo
-virtualenv env                               # for python 2.7
-python -m venv env                           # for python 3.4
-call env/Scripts/activate.bat
+python -m venv env
+call env\Scripts\activate.bat
 
 pip install -r requirements/base.txt
 pip install -r requirements/development.txt  # for development
 pip install -r requirements/postgres.txt     # for postgres
 pip install -r requirements/mysql.txt        # for mysql
 ```
 
+Download and install pandoc:
+
+```
+python -c "import pypandoc; pypandoc.download_pypandoc()"
+```
+
 Create a new file as `rdmo/settings/local.py`. You can use `rdmo/settings/sample.local.py` as template, i.e.:
 
 ```
-cp rdmo/settings/sample.local.py rdmo/settings/local.py
+copy rdmo\settings\sample.local.py rdmo\settings\local.py
 ```
 
 Configure your database connection using the `DATABASES` variable in this file. If no `DATABASE` setting is given `sqlite3` will be used as database backend.
@@ -43,6 +66,18 @@ In addition set `DEBUG = True` for the development setup.
 Then, setup the application:
 
 ```
-./manage.py migrate          # initializes the database
-./manage.py createsuperuser  # creates the admin user
+python manage.py migrate          # initializes the database
+python manage.py createsuperuser  # creates the admin user
+```
+
+Finally, install the front-end components. This can be done using bower:
+
 ```
+python manage.py bower install
+```
+
+Alternatively, if node.js, npm and/or bower are not available or not wanted on the machine, download the components from
+
+* https://github.com/rdmorganiser/rdmo-components/archive/master.zip
+
+and extract them into `components_root` in the `rdmo` directory. In both cases a `components_root/bower_components` containing various JavaScript and CSS libraries should be available.