Add support for Dev Containers/Codespaces (#1160)

diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
new file mode 100644 (file)
index 0000000..ca031c1
--- /dev/null
+++ b/.devcontainer/Dockerfile
@@ -0,0 +1,14 @@
+#syntax=docker/dockerfile:1.6
+
+FROM mcr.microsoft.com/vscode/devcontainers/python:3.12
+
+RUN <<EOF
+set -x
+set -e
+apt-get update
+apt-get install -yq --no-install-recommends \
+  ffmpeg \
+  ;
+apt-get clean
+rm -rf /var/lib/apt/lists/*
+EOF

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644 (file)
index 0000000..ea4b78a
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,12 @@
+{
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": ".."
+  },
+  "features": {
+  },
+  "postCreateCommand": "./.devcontainer/post-create.sh",
+  "forwardPorts": [
+    8095
+  ]
+}

diff --git a/.devcontainer/post-create.sh b/.devcontainer/post-create.sh
new file mode 100755 (executable)
index 0000000..37efaf5
--- /dev/null
+++ b/.devcontainer/post-create.sh
@@ -0,0 +1,13 @@
+#! /usr/bin/env bash
+
+
+if [ ! -d .venv ]
+then
+  python -m venv .venv
+fi
+
+source .venv/bin/activate
+
+pip install -e .[test]
+pip install -r requirements_all.txt
+pre-commit install

diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index ebf9a5a64845783a1c55c70bdccc193c96d664c8..37305ea9fc8fb7ee7ea9252dc792b13efa42e9d8 100644 (file)
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -9,6 +9,16 @@ Developer docs
 It is recommended to use Visual Studio Code as your IDE, since launch files to start Music Assistant are provided as part of the repository. Furthermore, the current code base is not verified to work on a native Windows machine. If you would like to develop on a Windows machine, install [WSL2](https://code.visualstudio.com/blogs/2019/09/03/wsl2) to increase your swag-level 🤘.
 
 ## 🚀 Setting up your development environment
+
+### Using Devcontainer/Codespace
+* Using Codespace: Create/open your Codespace, and wait for the creation
+* Using VSCode Dev Container locally: `Dev Containers: Open Folder in Container...`, select the root of the project, and wait for the creation
+* Once VSCode has loaded, after a few seconds a terminal should pop with `Running postCreateCommand...`. Wait for the dependencies to install. You can monitor it with `Codespaces: View Creation Log`
+* Select the right Python interpreter with `Python: Select Interpreter`, and choose `./.venv/bin/python`
+* Hit (Fn +) F5 to start Music Assistant locally
+* Go to the `PORTS` tab in the bottom panel, open the `Forwarded Address` for the port `8095` to access the pre-compiled UI of Music Assistant 🎉
+
+### Manually
 With this repository cloned locally, execute the following commands in a terminal from the root of your repository:
 * `python -m venv .venv` (create a new separate virtual environment to nicely separate the project dependencies)
 * `source .venv/bin/activate` (activate the virtual environment)