README.md

NotifyNL Local Environment

Important

Current operating systems supported are MacOS, Ubuntu and Windows (using an Ubuntu WSL2). For all others, you are on your own (though you can always ask @pgaetani).

Pre-requirements

• Install Docker
• Install VSCode
• Ask someone in the @admins group for an AWS user and an IAM role.
• Create a key and secret pair for said IAM role.

The Short Version

Warning

Makefile still under construction.

Use the long way to install.

Generate your environment variable files:

make configure

To install the requirements:

make setup

To run the environment:

make up

To stop the environment:

make down

Further Reading

• User credentials
• Recommended VSCode Extensions
• VSCode setup
• The long way to install

---

• Old Documentation