Better developer setup documentation

[sastels]

Description

As a developer, I need to be able to set up and run Notify locally so that I can test and debug issues.

We should write a new DEV_CONTAINERS.md readme file for setting up and running Notify.

• [x] it could live in the api repo perhaps, and be linked to from our other repos?
• [x] should go through opening admin, api, and document-download-api devcontainers and getting them all running locally together.
• [ ] should also include how to set up vscode debugging
• [x] we should add local config into to lastpass
• [x] should include a troubleshooting section

Acceptance Criteria** (Definition of done)

• [x] a new set of documentation for setting up the system using devcontainers

QA Steps

• [x] Get a non-Notify developer to see if they can follow the documentation and get things running.

[maxneuvians]

I would recommend the following:

• Use GitHub codespaces https://github.com/codespaces, this will allow you to define all you dev env secrets in GitHub secrets and load them in automagically to your environment (no lastpass)
• You can configure the dev container with all the right dependencies (API, Admin, Document Download, Postgres, Redis) in a docker compose network
• You can include all your required VSCode plugins for proper debugging and run postinstall scripts to install dependencies
• You can work VisualStudio code the same way it would if everything was running locally

[whabanks]

Some things from onboarding experience:

FAQ / Solutions to Common issues Doc

• API and Admin were placed in separate Docker networks - had to bring them together manually
• Document the need to retrieve container IP addresses and use them in .env configs to properly set up the apps. e.g. API_HOST_NAME in Admin and REDIS_URL in API
• Include a section about the black formatter and isort import order tools & integration in VScode. Not being aware of how to run them on files caused a bit of confusion while running tests for my first PR.
• Talend setup for hitting the API directly. (Currently working on a doc for this while setting it up myself.)

  Launching apps

• Some initial confusion on how to start the apps. From the Readmes I got the impression that we do one of:
  • run_app.sh
  • docker compose up
  • flask run -p <port> --host=<host>
• I learned that none of these are the preferred way, and was instead given a configured launch.json from another dev.
• Mention the relationship between FLASK_ENV and the config.py file. And that .env takes precedence over config.py. I found myself unsure during the Docker networking problem if config.py was of importance or not.

[whabanks]

First rough draft is up!

[yaelberger-commits]

90% done. New onboarding devs have used new documentation successfully