Sandcastle Reborn #12574

jjspace · 2025-04-18T15:37:11Z

Description

Starting work on rebuilding Sandcastle. Currently this branch has the scrapped together hackathon code. This branch and PR will act as a staging branch for the work involved in the whole process. See #12566 for more details

Added a new package packages/sandcastle to encapsulate the new Vite + React + Typescript project
Set up the Vite build to output into Apps/Sandcastle2 (temporary path)
- Running both the vite dev server and the static files from the normal CesiumJS dev server should behave the same. This requires a bit of extra config to make sure routes for assets and sample data line up. Should be working now but may require some finagling later if we change routes.

TODO:

Set up CI deployment

Issue number and link

Fixes #12566

Testing plan

From the top level

Run npm run build-sandcastle
Run npm start
Navigate to http://localhost:8080/Apps/Sandcastle2/index.html

From inside packages/sandcastle for direct development of sandcastle

Run npm run dev for the dev server build
Navigate to http://localhost:5173/

Author checklist

I have submitted a Contributor License Agreement
I have added my name to CONTRIBUTORS.md
I have updated CHANGES.md with a short summary of my change
I have added or updated unit tests to ensure consistent code coverage
I have updated the inline documentation, and included code examples where relevant
I have performed a self-review of my code

github-actions · 2025-04-18T15:37:37Z

Thank you for the pull request, @jjspace!

✅ We can confirm we have a CLA on file for you.

ggetz · 2025-04-24T20:54:28Z

Wahoo! @jjspace could you get this PR targeting to a feature branch for sandcastle v2? That way we can have smaller, iterative PRs as needed.

ggetz

Works great so far! I haven't reviewed any of the app code itself, since as I understand it is very much in flux. But I do have some thoughts on the overall configuration.

ggetz · 2025-04-24T20:49:03Z

package.json

+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-refresh": "^0.4.19",


I think these should all go into the dev dependencies for packages/sandcastle. Right?

Given the nature of eslint after the "single top level flat-config" change these are actually used in the top level eslint.config.js so they do need to be dev dependencies of the whole repo AFAIK.

ggetz · 2025-04-24T20:51:50Z

packages/sandcastle/public/Cesium.d.ts

Is this file built? Should it be it the .gitignore?

I believe this is here just because I had copied it for the hackathon project but it's not being used anymore. Will check and remove.

ggetz · 2025-04-24T20:53:31Z

packages/sandcastle/public/Sandcastle-client.js

@@ -0,0 +1,203 @@
+(function () {


I would love to modernize these functions and get them documented. Not sure where you're maintaining a TODO list, but that can get added in an iterative PR.

ggetz · 2025-04-24T20:55:36Z

gulpfile.js

@@ -250,6 +250,11 @@ export async function buildTs() {
    workspaces = packageJson.workspaces;
  }

+  // TODO: we probably need to manage workspaces better now
+  workspaces = workspaces.filter(


We probably want to target workspace which are dependencies to avoid the manual filtering.

ggetz · 2025-04-24T20:56:19Z

packages/sandcastle/public/Sandcastle-header.js

+    bucket = bucket.substring(pos + 1);
+  }
+
+  window.Sandcastle = {


Same comment as for Sandcastle-client.js.

ggetz · 2025-04-24T20:57:27Z

packages/sandcastle/public/gallery/3D Models.html

Is it possible to point this at the existing gallery directory?

Same as my other comment. I copied these for the hackathon and didn't remove them yet. They're not even referenced in the new app at all right now.

The whole gallery system might need a review of how we want to manage it so potentially a little in flux here too.

Cool, I think we address the strategy around the gallery in a subsequent PR. Let's just get this initial one cleaned up in the meantime.

I started a TODO list if only for my own sanity. Please feel free to edit or move.

ggetz · 2025-04-24T21:02:28Z

packages/sandcastle/src/assets/react.svg

ggetz · 2025-04-24T21:03:41Z

packages/sandcastle/src/gallery-index.ts

This is also a built file, and should be ignored.

This is actually not a built file right now. At the moment this is an array with the full code of each of the sandcastles I included in the project for the hackathon. it was just the quickest way I could get them in there without implementing the full parsing of how we're currently storing/loading the gallery. Definitely needs a review for how we're accessing them.

jjspace · 2025-04-24T21:22:38Z

could you get this PR targeting to a feature branch for sandcastle v2? That way we can have smaller, iterative PRs as needed.

@ggetz I was expecting this branch/PR to be that feature branch. I was thinking of developing directly here until the build system is mostly sorted then do smaller PRs into this branch for review as needed. Where you thinking differently?

ggetz · 2025-04-24T22:14:48Z

To keep things clean, let's target a new staging branch. That way we can merge this and keep the PR list tidy. Well... tidier.

jjspace added 5 commits April 15, 2025 16:59

create sandcastle package

eb55c7e

elevate eslint config, run prettier

793ba88

import hackathon code

8a73405

adjusting paths for built and local dev

c05ed50

readme and build commands

4a2082a

jjspace requested a review from ggetz April 18, 2025 15:37

fix ci

1d8cd04

jjspace marked this pull request as draft April 18, 2025 15:43

jjspace added 2 commits April 18, 2025 16:56

set up itwin-ui, fix types route

1522aa7

build for ci

f775608

ggetz reviewed Apr 24, 2025

View reviewed changes

Config setups, including CI

c3e3f11

remove extra files

db51183

This was referenced Apr 30, 2025

Rebuilding Sandcastle: Technical Implementation #12566

Open

cesium vite experiments #12581

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sandcastle Reborn #12574

Sandcastle Reborn #12574

jjspace commented Apr 18, 2025

github-actions bot commented Apr 18, 2025

ggetz commented Apr 24, 2025

ggetz left a comment

ggetz Apr 24, 2025

jjspace Apr 24, 2025

ggetz Apr 24, 2025

jjspace Apr 24, 2025

ggetz Apr 24, 2025

ggetz Apr 24, 2025

ggetz Apr 24, 2025

ggetz Apr 24, 2025

jjspace Apr 24, 2025

ggetz Apr 30, 2025

ggetz Apr 24, 2025

ggetz Apr 24, 2025

jjspace Apr 24, 2025

jjspace commented Apr 24, 2025

ggetz commented Apr 24, 2025

		"eslint-plugin-react-hooks": "^5.2.0",
		"eslint-plugin-react-refresh": "^0.4.19",

Sandcastle Reborn #12574

Are you sure you want to change the base?

Sandcastle Reborn #12574

Conversation

jjspace commented Apr 18, 2025

Description

Issue number and link

Testing plan

Author checklist

github-actions bot commented Apr 18, 2025

ggetz commented Apr 24, 2025

ggetz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjspace commented Apr 24, 2025

ggetz commented Apr 24, 2025