Add Dev Container configuration

[matthewruzzi]

Describe
It would be helpful to have a Dev Container configuration that would allow easily opening this repo in GitHub Codespaces with the simulator preconfigured to launch a sample project. The Light-weight Desktop (desktop-lite) Dev Container feature could be used to provide a browser based VNC viewer.

Why do you think this feature would be useful?
This would be the easiest way for people to try out Moddable without having to manually install it on their computer.

[phoddie]

Thanks for the suggestion. We're all for providing ways to make life easier for developers, especially getting started.

The topic of containers does come up from time to time. The challenge that we've encountered is that there are so many options for containers, and every developer seems to have their own preference.

If you have any guidance on how to deal with that challenge, we're all ears.

All that said, installing the Moddable SDK on your computer is easy enough – mostly Git clone, set $MODABLE, and build the tools (one line). You can also use xs-dev to automate that.

[matthewruzzi]

I tried to use xs-dev but kept getting error messages while setting it up: HipsterBrown/xs-dev#255

I was able to set up Moddable directly in a Codespace using the following config:

.devcontainer/devcontainer.json:

{
	"build": {
        "dockerfile": "Dockerfile"
    },
	"features": {
		"ghcr.io/devcontainers/features/desktop-lite:1": {}
	},
	"forwardPorts": [6080],
	"remoteEnv": {
	"MODDABLE":"/workspaces/moddable",
    "PATH": "/workspaces/moddable/build/bin/lin/release:${containerEnv:PATH}"
  }
}

.devcontainer/Dockerfile

FROM mcr.microsoft.com/devcontainers/base:ubuntu24.04

RUN apt-get update

RUN apt-get -y upgrade

RUN sudo apt-get -y install gcc git wget make libncurses-dev flex bison gperf

RUN sudo apt-get -y install libgtk-3-dev

[phoddie]

Thanks for putting this together, and especially for sharing it!. It is much simpler than I remember past efforts at this. I agree that we should include that in the Moddable SDK to make that option easy for developers. If you'd like to to turn this into a PR, that would be great. Otherwise, we can merge this and give you credit in the commit. Please let me know.

FWIW – I added node to the devcontainer.json to be able to use xsdb (command line JavaScript debugger).

[matthewruzzi]

What are the benefits of xs-dev over using Moddable directly? Would it be worth waiting and trying to get xs-dev working in the Codespace or just using Moddable directly as it is now?

[phoddie]

I'm a big fan of xs-dev. Beyond initial set-up, xs-dev has some great tools for installing the embedded SDKs and managing projects.

That said, having a container that is as simple and light as practical seems valuable. It is a foundation that other efforts can build on, including xs-dev. Having something that only depends on the Moddable SDK makes the sense as part of the Moddable SDK repo.