README.md

Good Thinking

Content Management System for Good Thinking, a Wagtail CMS site (which itself is built on the Django Python web framework).

Urls

The site is found at https://www.good-thinking.uk The Wagtail CMS for the site is at https://www.good-thinking.uk/admin

The staging site is https://ldmw-staging.herokuapp.com The staging cms is https://ldmw-staging.herokuapp.com/admin

Setup

This project uses:

• python (v3.6)
• postgres (9.6)
• elm (0.18)
• (optional)node (6.11) (Node is not necessary to run the project, however we're using it as a convenient way to install/build our elm files)

Clone the repository:

git clone https://github.com/mindwaveventures/cms.git && cd cms

Ensure you have the following environment variables in your $PATH

export AWS_ACCESS_KEY_ID=<aws_access_key_id>
export AWS_SECRET_ACCESS_KEY=<aws_secret_access_key>
export AWS_STORAGE_BUCKET_NAME=<aws_storage_bucket_name>
export DATABASE_URL=postgres://<database-username>:<database-password>@127.0.0.1:5432/<database-name>`
export DISABLE_COLLECTSTATIC=0
export DJANGO_SETTINGS_MODULE="cms.settings.dev"
export E24_URL="<value>"
export ELM_VERSION="0.18"
export GOOGLE_MAPS_KEY=<google_maps_key>
export GOOGLE_MAPS_KEY="<value>"
export GTM_TOKEN="<value>"
export MAINTENANCE_PAGE_URL="https://s3.amazonaws.com/londonminds/site-down.html"
export SECRET_KEY="<value>"

Note: if deploying on Heroku, DATABASE_URL will be auto-populated during the app provisioning process. Do not change the value added by Heroku. These credentials may change at any point, see https://devcenter.heroku.com/articles/heroku-postgresql-credentials#using-the-default-credential

The google maps API key can easily be obtained by clicking the get a key button at developers.google.com/maps/documentation/javascript/get-api-key

(Ensure postgres is running with: postgres -D /usr/local/var/postgres/)

(For the most up to date setup see the Wagtail getting started guide)

alias dj="python manage.py" # handy django alias
psql -c "create database cms" # create the cms database
dj migrate # set up the database
dj createsuperuser # create the admin account
dj runserver # start the django server
elm make ./cms/elm/Main.elm --output=./cms/static/js/elm.js # compile elm files

The project should now be running at: http://localhost:8000 The wagtail dashboard can be found at http://localhost:8000/admin

Vagrant

A Vagrantfile has been created in order to aid local development (ie minimising potential issues with a developer's own machine setup and provide a consistent, reproducible development, and then production, environment). Vagrant configuration is:

• Ubuntu 16.04 (64 bit), see app.vagrantup.com/ubuntu/boxes/xenial64
• Private IP address of 192.168.33.20
• Serves the web app on port 8001 (bound to the private IP address above) which is mapped to local port 8001 (ie developer's machine).
• All prerequisites are installed (see top of the Vagrantfile)
• A new Postgres database is created with
  • username: postgres
  • password: postgres
  • database name: goodthinking

To save repeated/manual work, customise IP address and port, and (particularly) environment variables before provisioning the VM (ie before the first start).

IP address and port

If changes to either private IP address or port are required, make changes in both Vagrantfile and good-thinking.sh.

If the private IP address has already been taken (maybe by another VM on the developer's machine), then Vagrant will display an error on startup.

If the host port has already been taken on the developer's machine then Vagrant will choose another port for us. Check the Vagrant startup messages.

Environment variables

Environment variables (as listed above) should be listed in newly created good-thinking-env-variables.sh script which should be placed in the root folder of the repo with the following format:

export AWS_ACCESS_KEY_ID="<value>"
export AWS_SECRET_ACCESS_KEY="<value>"
...

This good-thinking-env-variables.sh must not be checked in to git as it includes secret information.

Starting VM

To start this Vagrant machine, change to the local folder where this repo has been cloned and run vagrant up

Data

A new, blank, database is created during VM provision. In order to develop/test against a database with something in it (in particular a main, admin, user - see above), the staging database can be copied over as follows (run from the Vagrant VM):

pg_dump --host <staging-database-host> -U <username> --file=~/db_dump.sql <database-name>
sudo -u postgres psql -h localhost goodthinking postgres < ~/db_dump.sql
rm ~/du_dump.sql

The staging database password will be prompted for (first), as will the local database password (second).

DO NOT change the second sudo -u postgres psql ... database parameters in order to ENSURE that a database is NOT copied TO the staging site.

NEVER use the live site database connection details (in order to avoid any chance of error).

Changing source code (local and VM are both permitted)

The git repo is not re-downloaded in to the Vagrant machine. Rather the repo that has been downloaded on to the developer's local (or Vagrant host) machine is symbolically linked to the default Vagrant user's home directory (at ~ or /home/ubuntu). This allows the developer to edit with their favourite editor from their local machine and changes will be picked up inside the Vagrant VM, or within the Vagrant VM and changes will be reflected back in the local (host machine) folders. Or, more simply, changes to code in either the developer's local machine (host) or Vagrant VM (guest) will be reflected in the other.

Mapping (new) source files and folders

Newly created folders must be added to the following line:

for d in cms crisis feedback home likes media resources search static staticfiles; do sudo -u ubuntu ln -s /vagrant/$d .; done

Any newly created files in the root repo folder and required by the web app must be added to the following line:

for f in elm-package.json good-thinking-env-variables.sh good-thinking.sh manage.py package.json requirements.txt; do sudo -u ubuntu ln -s /vagrant/$f .; done

These changes will only be actioned when a VM is first provisioned (which happens when it's first brought up). Hence newly added root folders and files must be manually symbolically linked in order to make them available both locally (developer's machine) and to the VM (guest Vagrant machine).

Starting Wagtail site

The Wagtail site itself is not started during VM provision. It can be started by SSHing on to the VM (user ubuntu) and running:

~/.good-thinking.sh

This must be manually re-run if the Vagrant VM is halted and restarted.

The site will now be available from the developer's local machine at http://192.168.33.20:8001 subject to possible IP address and port number changes (as detailed above).

Load testing

Artillery is used for load testing. You can install artillery with the command npm install -g artillery, and continue following through the getting started guide.

We have 2 files for testing the staging and production sites. You can load test the staging site by making any changes you'd like to staging-load-test.yml and running the command artillery run staging-load-test.yml.

Similarly, you can load test the production site by editing prod-load-test.yml as necessary, and running artillery run prod-load-test.yml.

Wireframes

You can see our last updated set of wireframes here:

• Homepage
• Homepage mobile
• Subpage

Data

You can get the current data from the database by running:

  heroku pg:backups:download -a ldmw
  pg_restore --verbose --clean --no-acl --no-owner -d cms latest.dump

To set up the needed remotes for the project you should run the following:

# Remove all remotes
for r in $(git remote);do;git remote rm $r;done;
# Add the correct remotes
git remote add old https://git.heroku.com/ldmw-cms.git
git remote add heroku https://git.heroku.com/ldmw.git
git remote add staging https://git.heroku.com/ldmw-staging.git
git remote add origin https://github.com/ldmw/cms.git

git remote -v should output:

old https://git.heroku.com/ldmw-cms.git
staging https://git.heroku.com/ldmw-staging.git
heroku https://git.heroku.com/ldmw.git
origin https://github.com/ldmw/cms.git

Using the CMS

Editing the Homepage

Access the Homepage through the Explorer:

On the Homepage, click Edit, and you should be taken to the EDITING HOME PAGE page. From here you can edit the various fields on the Homepage. When you're done, you can click publish, which will publish your changes to the live site.

Adding Resources

From the Homepage, enter the Resources page.

From here you can edit the existing resources, or add a new one by selecting Add Child Page. When prompted to choose a page type, select Resource.

On the Content page, fill in the details of the resource you are adding. Then click on the Promote tab to add the tags.

The three types of tag are Main Tags (Categories/Sleep issues such as 'insomnia', 'fatigue' etc.), Audience Tags ('Men', 'Women' etc.), and Content Tags ('video', 'blog', 'article' etc.). Tags must be one word, or multiple words separated by a dash.

These tags will be added to the site if they did not already exist. When you have done this, click publish and the resource will be added to the site.

Add Pages

Static Pages consisting of just a heading paragraph/s and body paragraph/s can be added using the static page page type on wagtail.

These pages will be available at the site on /{page-title}. For example, the crisis page is visible at /crisis.

You can link to these pages from elsewhere by using an internal link, and selecting the page you want to link to.

Topic Pages

The resources are displayed on individual topic pages. In order to make them display, you have to tag them with a topic tag that corresponds to the slug of the topic page. For example, a resource tagged with anxious would display on the anxious page (https://www.good-thinking.uk/anxious/).

Adding Highlights of the month

Highlights of the month will be displayed on the Homepage.

On the Homepage, Click Edit, and you should to taken to the EDIT HOME PAGE page. From here you can edit the various fields on the Homepage. In the form you can see HIGHLIGHTS tab to add multiple resource page.

Adding Collections

Each topics page we can list the Collections of the Resources.

• Click on the Explorer -> Home -> Collections.
• Click on ADD CHILD PAGE, Choose Resource Collections
• Form here you can add the details of the Collections.
• On the PROMOTE tab we have to add TOPIC TAGS for which topic the collection is related. We can use same collection to multiple topics.
• After finished the form content, we can publish it to roll on the frontend.

Assessments

The Expert 24 assessments work in the same way as other resources. You add a new page of type assessment to the resources page, then tag it with the topic you would like it to appear under.

Resources can be added to the results of these assessments by adding a hidden tag to the resource that corresponds to a tag on the disposition of the assessment results. Only resources that match the topic of the assessment will display.

Deployment

The CMS is set to automatically push from the master branch to the staging area (https://ldmw-staging.herokuapp.com/). When we're happy this is working, we push manually to the production site.