A project to publish website analytics for Washington State University. This is a fork of the public domain analytics.usa.gov project.
master branch is mirrored to the 18F's
master branch. The
wsu-production branch contains all of the changes made by WSU. The code base is different enough now that changes from the upstream
master will not be merged into
wsu-production, though we keep an eye on changes and can cherry pick anything critical.
Install them all using bundler:
bundle install --path vendor/bundle
analytics-reporter is the code that powers the analytics dashboard. Please clone the
analytics-reporter next to a local copy of this github repository.
Run Jekyll with development settings:
bundle exec jekyll serve --watch --config=_config.yml,_development.yml, which will generate the final site output in
_site/, start a local webserver at
http://127.0.0.1:4000, and then regenerate
_site/ whenever files are modified.
Developing with local data
The development settings assume data is available at
/fakedata. You can change this in
Developing with real live data from
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
npm install -g serve
Generate data to a directory:
analytics --output [dir]
serve from the output directory:
The data will be available at
http://localhost:3000 over CORS, with no path prefix. For example, device data will be at
Deploying the app to production
In production, the site's base URL is set to
https://analytics.wsu.edu and the data's base URL is set to
To deploy this app to
analytics.wsu.edu, you will need authorized access to the Web Communication WSUWP Indie server. Your SSH configuration should use the
wsuwp-indie-prod-01 server alias and a key should be configured for the
To deploy the site once you have access, run:
Please tag any releases on the
wsu-production branch to track deployments.
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.