A suite of tools to visualize pageviews data of Wikimedia Foundation wikis
User documentation: https://meta.wikimedia.org/wiki/Pageviews_Analysis
Metaviews (pageviews of the Pageviews apps): https://tools.wmflabs.org/pageviews/meta
IE10 and Safari 8 and below are not supported.
This guide mostly assumes you’re using OSX or Linux. The setup process may differ on Windows machines.
PHP is for rendering partials in the views and for the Intuition i18n framework. There otherwise is no backend logic.
*The linters are not necessary, but preferred so your code maintains a consistent style.
Install all node packages and dependencies with
composer updateto install all PHP dependencies
Create a copy of
config.php, and within that file, set
ROOTDIRto your project root path.
NOTE: Some routing in the app uses absolute paths, hence you may wish to modify your local web server to point to
localhost/pageviews as opposed to browsing directly to the PHP file. In Apache, under
<IfModule alias_module> you can create an alias with
Alias /pageviews /path/to/pageviews/public_html Alias /massviews /path/to/pageviews/public_html/massviews
and so forth for all the other apps.
All assets and views are ultimately placed in
public_html. With the exception of images, you won’t need to make any manual modifications to this directory.
The repo contains seven separate applications that share code with each other (Pageviews, Langviews, Topviews, Siteviews, Massviews, Redirect Views, and Userviews). The root directory of
views represent the Pageviews app. Other apps have a subdirectory therein. The main development asset files share the same name as the app (e.g.
application.css. PHP partials and Sass imports are prepended with underscores (e.g.
Browserify is used to help follow a module pattern. You’ll need to
Each app has it’s own
config.js, which are constants for application-wide use. Pageviews and Siteviews have a
templates.js file that defines how data is shown in the right column on the interface.
/shared directory and must be required as needed.
list_helpers.js is used on apps that have a list view, which are Massviews and Langviews. All apps but Topviews show a chart of some sort, and require
When the JS files are compiled, they are concatenated into a single
application.js that lives within the directory for that app inside
gulp jsdoc && open jsdocs/gen/index.html
Each page has it’s own
.scss file that imports dependencies. Shared files are simply prefixed with an underscore.
_list_view.scss is imported by apps that have a list view (Langviews, Massviews), and
_chart_view.scss by apps that show charts.
The views within
/views are written in MtHaml and compiled to PHP files in
gulp to simply watch for changes and automatically compile as needed. You can also run tasks by app and function, such as
gulp massviews for all Massviews-related files, or
gulp by itself should be all you need.
Before making a pull request or pushing to master, remember to run
gulp production so the assets are minified and concatenated. JSDocs are also generated, and placed in a dedicated sub-repo (not submodule) in
jsdocs/gen. These can optionally be pull requested to the JSDocs repo.
Tests will be ran automatically when you push or create a pull request.
IMPORTANT: The default browser Selenium uses is Firefox, and as of Firefox 47 the necessary webdriver,
FirefoxDriver has been removed. A working combination is Selenium WebDriver 2.53.1 and Firefox 47.0.1 (not Firefox 47, or later versions than 47.0.1). Once installed run
java -jar selenium-server-standalone-2.53.1.jar to start the selenium server and
./nightwatch to run the tests. You can run specific tests with
./nightwatch --test tests/my_test.js.
If a test fails when you push to remote, check the build and there will be a link to a video of the test, along with the output of the logs.
The styling of all ES6 and SCSS is enforced with linters. You can run these locally with
gulp lint, and will also be ran when you run
gulp production. If you need a particular rule to be ignored, you can add exceptions (see Scss-lint, Eslint).