Note This project is no longer maintained.
Note Sauce Labs tests are only run on PRs from the main repo or commits to master.
This project comprises all styles, behaviour and interfaces for mozilla/payments.
Run tasks with
grunt watch-static or
|build||build all CSS/JS files for deployment|
|serve||watch CSS/JS for changes; serves static files via
|test||run tests locally|
|test-sauce||run full Sauce Labs test suite|
|watch-email||watch email-specific static files for changes; updates CSS/JS on change|
|watch-static||watch files for changes; updates CSS/JS on change|
To get the right paths for the email CSS and rebuild files as they change run:
DEV=1 grunt watch-email
Dependency installation and updates
npm install -g grunt-cli.
npm install to install the local deps needed for development.
Dependencies are automatically kept up-to-date using greenkeeper.
npm deps only
We're aiming to only use npm packaged deps rather than bower. This is to be able to track dep versions in one place.
Libraries + external deps
Normally built artifacts aren't committed. However, to manage dep changes more tightly, production libs (JS, CSS + fonts) are committed to the tree.
JS libs are committed from
node_modules as webpack knows how to find deps in
Whilst this creates noise it does help ensure deps in the browser are identical and can't get mangled by a broken deps installation.
dealing with bower
Unfortunately some deps only work with bower. For these cases, make sure
bower.json has the package name and version, run
bower install, and
commit the distributed files to
public/bower_components. Hopefully these
cases will be rare.
Watching for file changes in development.
If you're using payments-env
to run the complete payments system then you'll want to use
grunt watch-static on your host to watch for file changes.
In other words, start docker to run all the things but keep a shell open
on the host machine just to compile static assets for the docker VM to serve.
Hot module reloading
If you run the webpack-dev-server you can get hot module reloading. This turns on a feature where the code automatically updates in the browser as you change the code in your editor.
For example run
grunt serve to run the webpack-dev-server.
And then visit:
You should find that changes to the react modules are reflected immediately without refresh. Read on if you want to also interact with the API server.
Developing with webpack-dev-server + docker for hot reloading.
If you are running the full stack with payments-env then you'll also be able to interact with the API when using hot reloading.
First, create an
/etc/hosts entry like
so that you can access your webpack server on a predictable host.
To see the purchase interface with hot module loading enabled visit the example site at:
To see the management interface:
enabling eslint (see below for how to configure vim + syntastic). Alternatively
just run the
grunt eslint command which is self-contained.
Eslint Vim settings (Syntastic)
You'll need the packages listed below installed globally:
npm install -g eslint babel-eslint eslint-plugin-react
Using syntastic, the following snippet turns on eslint selectively for projects with a .eslintrc.
To run the tests locally run:
grunt test. This will run the unit tests
The tests are run only on Firefox when a PR is submitted. When that code is landed on master, Travis will run the tests on Sauce Labs.
Running Sauce Labs on a PR [Team Only]
If you're a member of the payments team and you want to get Sauce Labs coverage
for a PR - push the branch to the main
mozilla/payments-ui repo and make a PR
Running the tests on SauceLabs locally
First Sign-up for a Sauce Labs 'Open Sauce' account to get your keys.
Then you'll need to export the SauceLabs username and access key as env vars:
export SAUCE_USERNAME=<YOUR_OPEN_SAUCE_USERNAME> export SAUCE_ACCESS_KEY=<YOUR_ACCESS_KEY>
Then you should find you can run:
grunt karma:sauce and run all the tests on SauceLabs.
The styleguide is based on the styles and templates that live in the tree.
It can be build statically with the
grunt build-styleguide command.
The styleguide is published here.
Updating the styleguide
Running the styleguide locally
grunt styleguide (defaults to running on localhost:4001).
We're using grunt-i18n-abide to run the extraction commands.
Because we're using React we need to operate on the compiled JS file. This also means we aren't running extraction on un-used code.
To run an extraction, checkout out the payments-l10n repository so that it has the same parent directory as payments-ui (
../payments-l10n from the current location). Then do the following:
npm install grunt webpack abideExtract