diff --git a/docs/setup-dev-environment.md b/docs/setup-dev-environment.md
index bba5425d..eaf16fc7 100644
--- a/docs/setup-dev-environment.md
+++ b/docs/setup-dev-environment.md
@@ -25,11 +25,13 @@ Now we install some essential tools.
`sudo apt-get install -y build-essential git vim-nox wget curl`
+
Now install python and related tools.
`sudo apt-get install -y python3 python3-pip python3-dev python3-venv`
+
Next install postgres and postgis to enable support for geographical objects.
`sudo apt-get install -y postgresql postgresql-contrib libpq-dev postgis postgresql-10-postgis-2.4`
@@ -39,11 +41,13 @@ and additional geo-spatial tools
`sudo apt-get install -y gdal-bin libspatialindex-dev libgeos-dev libproj-dev`
+
Now clone the colouring london codebase.
`git clone https://github.com/tomalrussell/colouring-london.git`
+
Now install Node. It is helpful to define some local variables.
`NODE_VERSION=v8.11.3`
@@ -61,6 +65,7 @@ Now install Node. It is helpful to define some local variables.
`rm node-$NODE_VERSION-$DISTRO.tar.xz`
+
Now add the Node installation to the path and export this to your bash profile.
`cat >> ~/.profile <
+
Ensure the `en_US` locale exists.
`sudo locale-gen en_US.UTF-8`
+
Configure the database to listen on network connection.
`sudo sed -i "s/#\?listen_address.*/listen_addresses '*'/" /etc/postgresql/10/main/postgresql.conf`
-Allow authenticated connections from any IP (so includes host).
+
+Allow authenticated connections from any IP (so includes the host).
`echo "host all all all md5" | sudo tee --append /etc/postgresql/10/main/pg_hba.conf > /dev/null`
+
Restart postgres to pick up config changes.
`service postgresql restart`
+
Create a superuser role for this user (``) if it does not already exist. The password `` is arbitrary and probably should not be your Ubuntu login password.
`sudo -u postgres psql -c "SELECT 1 FROM pg_user WHERE usename = '';" | grep -q 1 || sudo -u postgres psql -c "CREATE ROLE SUPERUSER LOGIN PASSWORD '';"`
+
Create a colouring london database if none exists. The name (``) is arbitrary.
`sudo -u postgres psql -c "SELECT 1 FROM pg_database WHERE datname = '';" | grep -q 1 || sudo -u postgres createdb -E UTF8 -T template0 --locale=en_US.utf8 -O `
+
Create the necessary postgres extensions.
`psql -d -c "create extension postgis;"`
@@ -122,6 +134,7 @@ Create the necessary postgres extensions.
`psql -d -c "create extension pg_trgm;"`
+
Now run all 'up' migrations to create tables, data types, indexes etc. The `.sql` scripts to do this are located in the `migrations` folder of your local repository.
`ls ./colouring-london/migrations/*.up.sql 2>/dev/null | while read -r migration; do psql -d < $migration; done;`
@@ -151,6 +164,7 @@ Now install the required python packages. This relies on the `requirements.txt`
+
#### Setting up Node
Now upgrade the npm package manager to the most recent release with global privileges. This needs to be performed as root user, so it is necessary to export the node variables to the root user profile. Don't forget to exit from root at the end.
@@ -167,6 +181,7 @@ Now upgrade the npm package manager to the most recent release with global privi
+
Now install the required Node packages. This needs to done from the `app` directory of your local repository, so that it can read from the `package.json` file.
`cd ./colouring-london/app && npm install`
@@ -182,6 +197,7 @@ Now we are ready to run the application. The `APP_COOKIE_SECRET` is arbitrary.
+
If you a running Ubuntu in a virtual environment you will need to configure networking to forward ports from the guest to the host. For Virtual Box the following was configured under NAT port forwarding.
@@ -197,6 +213,7 @@ ssh | TCP | 4022 | 22
The site can then be viewed on http://localhost:8080. The `app_dev` mapping is used in development by Razzle which rebuilds and serves client side assets on the fly.
+
Finally to quit the application type `Ctrl-C`.