V-4 DX: Single command to setup local development environment for onboarding
As a Software developer, I need to run a development environment in a single command, in order to get started quickly.
As a Software developer on mac os, I need a documented example of a working development environment, in order to develop against the target.
During onboarding it has shown that 50% of the potential voluntary developers do not finish setting up their development environment, because it is too complicated. We need to make it easier, so that we enable more voluntary contributions.
The development environment must also provide a complete set of facilities to simulate a real-world environment, in order to develop against all supported runtime code paths.
–
-
It is possible to run the development environment with a single command #2071 -
It is possible to develop against a local single node development environment -
Nginx works for a single node deployment -
The single node URL is added as a CSRF trusted origin, which permits login
-
-
The Docker Compose syntax is as much reduced as possible by using as many conventions as possible -
Add healthchecks where possible -
Use pinned minor versions of containers for all services -
Separate different runtime environments into separate manifests/overlays -
Environment files are consolidated, generated from templates and separated by environment
-
-
Documentation names prerequisites, assumptions and instructions with an example -
DNS is configured and available for the host and for the containers -
DNS configuration is documented for Linux w/ systemd-resolved/resolvectl + mac os -
Local Funkwhale instances are reachable by the host via HTTPS #2107 -
Local Funkwhale instances can reach each other via HTTPS #2107
–
Follow up
-
Supplying a conventional repository directory structure -
Certificates are installed into the browser and into the system -
A local nullmailer is available to debug MX integration
–
Also see:
Edited by jon r