Wikimedia Product Infrastructure team/Push Notifications Infrastructure/Push notifications service development setup

= Push Notifications service development setup =

An easy way to run push-notifications with a few commands and keep the development environment consistent across different OSes. The containers use the "host" network mode and therefore it can have network conflicts with local installations.

Requirements
You'll need a locally running Docker and Docker Compose:


 * Docker installation instructions
 * Docker Compose installation instructions

Linux users

We recommend installing  by downloading the binary release. You can also use, your OS package manager, or even run it in a container, but downloading the binary release is the easiest method.

MacOS & Windows prerequisites
Hopefully, this should Just Work™.

Linux prerequisites
If you are developing on a Linux system, copy the override settings to the default override file:

Next, ensure that  and   are set in your environment:

The above lines may be added to your  or other shell configuration.

If you are using fish shell, make sure to set the environment variables like this:

Start environment
Start the environment:

make task runner commands
Execute `npm install` inside the push-notifications container:

Execute `npm test` inside the push-notifications container:

Integration with MW
TBD