87f54d1e88
A while ago diffDOM moved its code to use ES6 modules and started using various language features specific to ES6. These two things happened independently btw. The result of this is that the version of diffDOM suitable for our build pipeline, structured as an immediately invoked function evocation (IIFE), now requires polyfills of some ES6 features to work in the older browsers we support, like IE11. It's also worth noting that in the move to ES6 the maintainers of diffDOM have adopted a process whereby users who need to support older browsers now have to add polyfill code for any ES6 features they choose to use. This commmit proposes a move to the domdiff library instead because: - it runs on all javascript runtimes with no polyfills - it is 2KB instead of diffDOM's 25KB Domdiff takes a different approach to diffDOM, in that it compares existing nodes and new nodes and replaces the existing ones with the new ones if there are differences. By contrast, diffDOM will make in-place changes to nodes if there are enough similarities. In other words, in most situations, diffDOM won't change the node in $component whereas domdiff will. Because of this, I've had to change the updateContent.js code to cache the data-key attribute's value so we don't lose access to it by overwrite the $component variable with a different jQuery selection.
notifications-admin
GOV.UK Notify admin application - https://www.notifications.service.gov.uk/
- Register and manage users
- Create and manage services
- Send batch emails and SMS by uploading a CSV
- Show history of notifications
Setting up
Python version
At the moment we run Python 3.6 in production.
NPM packages
brew install node
NPM is Node's package management tool. n is a tool for managing different versions of Node. The following installs n and uses the long term support (LTS) version of Node.
npm install -g n
n lts
environment.sh
In the root directory of the application, run:
echo "
export NOTIFY_ENVIRONMENT='development'
export FLASK_APP=application.py
export FLASK_ENV=development
export WERKZEUG_DEBUG_PIN=off
"> environment.sh
AWS credentials
To run parts of the app, such as uploading letters, you will need appropriate AWS credentials. See the Wiki for more details.
To run the application
# install dependencies, etc.
make bootstrap
# run the web app
make run-flask
Then visit localhost:6012.
Any Python code changes you make should be picked up automatically in development. If you're developing JavaScript code, run npm run watch to achieve the same.
To test the application
# install dependencies, etc.
make bootstrap
# run all the tests
make test
# continuously run js tests
npm run test-watch
To run a specific JavaScript test, you'll need to copy the full command from package.json.
To update application dependencies
requirements.txt is generated from the requirements.in in order to pin versions of all nested dependencies. If requirements.in has been changed, run make freeze-requirements to regenerate it.