moneyadviceservice / publify

Money Advice Service's Marketing Blog

MAS Marketing Blog

What is this?

The marketing blog application for the Money Advice Service.

What's Publify?

We forked the blogging engine - Publify for purposes of the MAS Marketing Blog.

The feeling was that we would diverge far enough that tracking/merging upstream would be an issue.

Publify has been around since 2004 and is the oldest Ruby on Rails open source project alive.

How do I run it?

Installation

Prerequisites

• Ruby 2.5.3
• Node.js
• Bower
• MYSQL
• PhantomJS

Note: Make sure you've added all the required API keys for the app to work properly, refer to Environment File Setup below.

pg gem issues on Mac OSx

When running the setup script you may run into an install issue with the pg (PostgreSQL) gem. If this occurs, you'll need to install it first via Homebrew brew install postgresql and then run the setup again.

Database Setup

You will need to remove the username and password lines from the config/database.yml and config/database.yml.postgres files. These values are required for the build process and will throw an error locally.

Enviroment File Setup

You'll need to set the environment keys this repo requires in .env. If this file doesn't already exist, it will be auto generated when you run the setup script. Otherwise, confirm that the variables in your .env match those in .env-example. You will need to change the WEBPURIFY_API_KEY value which you can find on WebPurify's website. Login details for the MAS account are on KeePassX.

Setup Script

This repository comes equipped with a self-setup script:

$ ./bin/setup
$ rails s

The blog is on /blog, and admin is /blog/admin

Testing

$bundle exec rspec

Run with COVERAGE=true in your test environment to report on coverage.

$ ./node_modules/karma/bin/karma start ./spec/js/karma.conf.js --single-run
$ ./node_modules/jscs/bin/jscs app/assets/javascripts/components/
$ ./node_modules/jshint/bin/jshint app/assets/javascripts/components/ --config .jshintrc

Deploying to a test environment

The Blog (previously on Heroku) is now deployed via Go.

To deploy:

• Make a feature branch off of master and build the feature.
• Once you are in a position to deploy this feature, make a new branch from your local feature branch. The name of the new branch should be the name of the environment you want to deploy to: uat/qa/preview.
• git push -f origin <uat/qa/preview>
• In GO the blog_commit_<uat/qa/preview> pipeline will automatically start building. Once successfully complete all you need to do is start the deploy_to_<uat/qa/preview> pipeline. This grabs the responsive_commit, blog_commit and cms_commit and deploys all three applications.
• No version bumps are needed until you are deploying to staging