A project to publish website analytics for the States of Jersey government. Based on a project by 18F for the Government of the United States of America (original project here - https://github.com/18F/analytics.usa.gov).
Clone or download
Pull request Compare This branch is 105 commits ahead, 142 commits behind 18F:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_agencies
_data_pages
_includes
_layouts
_site
css
fonts
images
js
sass
.about.yml
.gitignore
404.html
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE.md
Makefile
README.md
_config.yml
_development.yml
data.html
index.html

README.md

webanalytics.gov.je

A project to publish website analytics for the States of Jersey government and is a fork of analytics.usa.gov.

For a detailed description of how the site works, read 18F's blog post on analytics.usa.gov.

Other organizations who have reused this project for their analytics dashboard:

This blog post details their implementations and lessons learned.

Setup

Ths app uses Jekyll to build the site, and Sass, Bourbon, and Neat for CSS.

Install them all:

bundle install

analytics-reporter is the code that powers the analytics dashboard. Please clone the analytics-reporter next to a local copy of this github repository.

Adding Additional Agencies

  1. Ensure that data is being collected for a specific agency's Google Analytics ID. Visit 18F's analytics-reporter for more information. Save the url path for the data collection path.
  2. Create a new html file in the _agencies directory. The name of the file will be the url path.
touch _agencies/agencyx.html
  1. Create a new html file in the _data_pages directory. Use the same name you used in step 2. This will be the data download page for this agency
touch _data_pages/agencyx.html
  1. Set the required data for for the new files. (Both files need this data.) example:
---
name: Agency X # Name of the page
data_url: https://analytics.usa.gov/data/agencyx # Data URL from step 1
slug: agencyx # Same as the name of the html files. Used to generate data page links.
layout: default # type of layout used. available layouts are in `_layouts`
---
  1. Agency page: Below the data you just entered, include the page content you want. The _agencies page will use the charts.html partial and the _data_pages pages will use the data_download.html partial. example:
{% include charts.html %}

Developing locally

Run Jekyll with development settings:

make dev

(This runs bundle exec jekyll serve --watch --config=_config.yml,_development.yml.)

Developing with local data

The development settings assume data is available at /fakedata. You can change this in _development.yml.

Developing with real live data from analytics-reporter

If also working off of local data, e.g. using analytics-reporter, you will need to make the data available over HTTP and through CORS.

Various tools can do this. This project recommends using the Node module serve:

npm install -g serve

Generate data to a directory:

analytics --output [dir]

Then run serve from the output directory:

serve --cors

The data will be available at http://localhost:3000 over CORS, with no path prefix. For example, device data will be at http://localhost:3000/devices.json.

Deploying the app to production

In production, the site's base URL is set to http://webanalytics.gov.je and the data's base URL is set to http://webanalytics.gov.je/data/live.

To deploy this app to webanalytics.gov.je, you will need authorized access to the States of Jersey's git repo for the project.

To deploy the site, run:

make

Use the full command above. The full command ensures that the build completes successfully. This creates/updates the _site folder. Then commit the changes to SoJ_Live branch to this Github repo. This will automatically deploy to the live server (you may have to clear the cache or wait a few minutes to see changes).

Environments

Environment Branch URL
Production SOJ_Live http://webanalytics.gov.je

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.