chore: update to use submodule in build in ci

Author: ayushtom

.github/workflows/ci.yml

@@ -11,13 +11,39 @@ env:
   RUST_VERSION: 1.81.0
 
 jobs:
+  build-explorer:
+    runs-on: ubuntu-latest
+    needs: [fmt, cairofmt]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+      - name: Build Explorer UI
+        run: |
+          cd crates/katana/explorer/ui
+          bun install
+          bun run build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: explorer-dist
+          path: crates/katana/explorer/ui/dist
+
   build:
     runs-on: ubuntu-latest-4-cores
-    needs: [fmt, cairofmt]
+    needs: [fmt, cairofmt, build-explorer]
     container:
       image: ghcr.io/dojoengine/dojo-dev:v1.2.1
     steps:
       - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions/download-artifact@v4
+        with:
+          name: explorer-dist
+          path: crates/katana/explorer/ui/dist
       - uses: Swatinem/rust-cache@v2
       - run: |
           cargo build -r --bin katana

.gitignore

@@ -24,3 +24,6 @@ examples/spawn-and-move/manifests/saya/**
 **/*.log
 
 artifacts/
+
+# Explorer build output
+crates/katana/explorer/ui/dist/

.gitmodules

@@ -4,3 +4,7 @@
 [submodule "crates/katana/contracts/piltover"]
 	path = crates/katana/contracts/piltover
 	url = https://github.com/keep-starknet-strange/piltover.git
+[submodule "crates/katana/explorer/ui"]
+	path = crates/katana/explorer/ui
+	url = https://github.com/ayushtom/dojo-explorer
+	branch = dist

crates/katana/cli/src/args.rs

@@ -243,11 +243,16 @@ impl NodeArgs {
             };
 
             let mut cors_origins = self.server.http_cors_origins.clone();
-
+            
             // Add explorer URL to CORS origins if explorer is enabled
             if self.explorer.explorer {
+                // Add both http://127.0.0.1:PORT and http://localhost:PORT
+                cors_origins.push(
+                    HeaderValue::from_str(&format!("http://127.0.0.1:{}", self.explorer.explorer_port))
+                        .context("Failed to create CORS header")?,
+                );
                 cors_origins.push(
-                    HeaderValue::from_str(&format!("{}", self.explorer.addr()))
+                    HeaderValue::from_str(&format!("http://localhost:{}", self.explorer.explorer_port))
                         .context("Failed to create CORS header")?,
                 );
             }

crates/katana/explorer/Cargo.toml

@@ -1,18 +1,15 @@
 [package]
-build = "build.rs"
-description = "Embedded explorer UI for Katana"
-edition.workspace = true
-include = [ "Cargo.toml", "build.rs", "dist/**/*", "src/**/*" ]
-license.workspace = true
 name = "katana-explorer"
-repository.workspace = true
 version.workspace = true
+edition.workspace = true
+repository.workspace = true
+license-file.workspace = true
 
 [dependencies]
 anyhow.workspace = true
-tracing.workspace = true
 url.workspace = true
+tiny_http.workspace = true
+tracing.workspace = true
 
-rust-embed = "6.8.1"
-tiny_http = "0.12"
-urlencoding = "2.1.2"
+[build-dependencies]
+anyhow.workspace = true

crates/katana/explorer/README.md

@@ -1,10 +1,50 @@
 # Katana Explorer
 
-This crate embeds the Katana Explorer UI files directly into the binary, eliminating the need for users to build the explorer themselves.
+This crate provides the Katana Explorer UI server functionality. The UI code is maintained in a separate repository and included here as a git submodule.
 
 ## Structure
 
-The explorer build files are expected to be in the `dist` directory within this crate. These files are embedded at compile time using the `rust-embed` crate.
+The explorer UI code is located in the `ui` directory as a git submodule. The built files must be present in `ui/dist` directory for the explorer to work.
+
+## Building the Explorer
+
+### In CI
+
+The explorer UI is automatically built in CI before building Katana. This ensures that the explorer UI is always available when building official releases.
+
+### Building Locally
+
+If you need to build the explorer UI locally:
+
+1. Initialize the submodule:
+
+```bash
+git submodule update --init --recursive
+```
+
+2. Build the UI:
+
+```bash
+cd ui
+bun install
+bun run build
+```
+
+The build output will be placed in `ui/dist`. This directory must exist and contain the built files for the explorer to work.
+
+## Runtime Behavior
+
+The explorer will fail to start if the UI build files are not found. This is intentional to prevent running with missing or outdated UI files.
+
+## Development
+
+For local development of the UI:
+
+1. Initialize the submodule as described above
+2. Navigate to the UI directory: `cd ui`
+3. Start the development server: `bun run dev`
+
+Note: The `ui/dist` directory is gitignored to prevent committing built files.
 
 ## Utilities