eth-library · jcardozo-eth · Sep 18, 2024 · Sep 15, 2024 · Sep 15, 2024 · Sep 15, 2024
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,9 @@
+{
+  "name": "Spring Boot Devbox Isolated Environment Demo",
+  "build": {
+    "dockerfile": "../Dockerfile"
+  },
+  "forwardPorts": [8080],
+  "remoteUser": "root",
+  "postCreateCommand": "devbox run compile"
+}
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,31 @@
+# Use Ubuntu as the base image
+FROM ubuntu:24.04
+
+# Update package list and install essential tools (curl, ca-certificates)
+RUN apt-get update && \
+    # Install packages without prompts and recommendations
+    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    curl \
+    ca-certificates && \
+    # Clean up apt cache to reduce image size
+    apt-get clean && \
+    # Delete downloaded package lists
+    rm -rf /var/lib/apt/lists/*
+
+# Install Nix Package Manager using the Determinate Systems Nix installer
+RUN curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install linux \
+  --extra-conf "sandbox = false" \
+  --init none \
+  --no-confirm
+
+# Set PATH environment variable to include Nix binaries
+ENV PATH="${PATH}:/nix/var/nix/profiles/default/bin"
+
+# Launch systemd
+CMD [ "/bin/systemd" ]
+
+# Install Devbox using Nix
+RUN nix profile install nixpkgs#devbox
+
+# Expose port 8080 to handle requests to web server
+EXPOSE 8080
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ Ensure that you have Devbox installed and configured. Devbox manages the depende
 
 ### Steps to Run
 
+#### Option 1: Locally
+
 1. **Clone the repository**
    ```bash
    git clone https://github.com/eth-library/devbox-spring-demo.git
@@ -44,6 +46,25 @@ Ensure that you have Devbox installed and configured. Devbox manages the depende
    ```bash
    curl "http://localhost:8080/greeting?name=Devbox%20Tester"
 
+#### Option 2: Using GitHub Codespaces
+
+1. Fork this repository
+
+2. From the **Code** dropdown, select **Create codespace on main**
+
+3. Once the codespace has loaded, run `devbox run start` in the terminal to start the webserver.
+
+    ```bash
+    devbox run start
+    ```
+
+4. When prompted, click **Open in Browser**.
+
+> [!TIP]
+> If the popup is not visible, you can navigate to the **Forwarded Ports** tab, and open the **Forwarded Address** for port 8080.
+
+5. **Success!** You'll see the landing page and can now curl the greeting endpoint!
+
 ## Custom Maven Settings
 
 To maintain an isolated environment, a custom `maven.config` file is provided in the `.mvn` directory. This configuration ensures that all Maven dependencies are stored locally within the project rather than in a global repository. This approach helps to keep the development environment fully isolated, avoiding any interference from global dependencies.
diff --git a/devbox.json b/devbox.json
@@ -9,8 +9,17 @@
       "echo 'Welcome to devbox!' > /dev/null"
     ],
     "scripts": {
+      "compile": [
+        "mvn compile"
+      ],
       "test": [
         "mvn test"
+      ],
+      "start": [
+        "mvn spring-boot:start"
+      ],
+      "stop": [
+        "mvn spring-boot:stop"
       ]
     }
   }

diff --git a/src/main/resources/static/index.html b/src/main/resources/static/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+    <title>Devbox Spring Demo</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+</head>
+<body>
+<p>Hi there!</p>
+<p>The webserver was started to serve the Devbox Spring Demo application.</p>
+<p>Visit or curl the <a href="/greeting">greeting endpoint</a> to test the API.</p>
+<p>Refer to the <a href="https://github.com/eth-library/devbox-spring-demo">GitHub repository</a> for more information.</p>
+</body>
+</html>