CatColab has experimental support for development using a dev container, which simplifies the setup process by providing a pre-configured environment via a Dockerfile. This is most useful for developers using Visual Studio Code or other editors that support the dev containers standard.
To use the dev container:
- Ensure you have a container runtime installed and running on your machine. You can refer to the Open Container Initiative for more information on container standards and runtimes. For practical guidance, you might consider starting with Docker's Get Started Guide.
- Open the CatColab repository in VS Code.
- Open the VS Code command pallet by pressing
Cmd+Shift+Pon macOS orCtrl+Shift+Pon Linux - Issue the command "Dev Containers: Reopen in Container".
- Once the container is running, the necessary setup commands will be executed automatically.
- VS Code will prompt "Your application running on port 5173 is available. See all forwarded ports". Click the link to open the application in your browser.