feat: Add an utility to run API containers easier

Author: emyller

bin/README.md

@@ -0,0 +1,26 @@
+# Local maintenance utilities
+
+This directory contains scripts to help running and maintaining the Flagsmith
+API in the local environment.
+
+## Requirements
+
+- Docker
+
+That's it. These scripts are designed to interact with the application runtime
+through ephemeral Docker containers.
+
+## Scripts
+
+### `bin/run`
+
+Runs any command within the `api` container. Examples:
+
+- `bin/run` — runs pending migrations and starts the API HTTP server in dev mode.
+- `bin/run bash` — starts a bash shell in the API container.
+- `bin/run python manage.py makemigrations` — runs the command in the API container.
+- `bin/run flagsmith createsuperuser` — the Flagsmith CLI should be there too!
+- `bin/run pytest --sw --pdb api/tests/unit/test_my_feature.py` — you get it.
+
+> This script is intended as a one-command option to run Flagsmith code with no
+> previous setup except from installing Docker.

bin/run

@@ -0,0 +1,5 @@
+#!/bin/sh
+#
+# Runs any command from within an application container.
+# If no command is given, it runs the application's default command.
+docker compose -f docker/new/docker-compose.yml run --rm $([ $# -eq 0 ] && echo --service-ports --use-aliases) api "$@"