Menu Close Get started
v0.39.0.1 / Developers Guide Vscode

Developing Metabase with Visual Studio Code

These instructions allow you to work on Metabase codebase on Windows, Linux, or macOS using Visual Studio Code, without manually installing the necessary dependencies. This is possible by leveraging Docker container and the Remote Containers extension from VS Code.

For more details, please follow the complete VS Code guide on Developing inside a Container. The summary is as follows.

Requirements:

Important: Ensure that Docker is running properly and it can be used to download an image and launch a container, e.g. by running:

$ docker run hello-world

If everything goes well, you should see the following message:

Hello from Docker!
This message shows that your installation appears to be working correctly.

Steps:

  1. Clone Metabase repository

  2. Launch VS Code and open your cloned Metabase repository

  3. From the View menu, choose Command Palette… and then find Remote-Container: Reopen in Container. (VS Code may also prompt you to do this with an “Open in container” popup). Note: VS Code will create the container for the first time and it may take some time. Subsequent loads should be much faster.

  4. Use the menu Terminal, New Terminal to open a new embedded terminal. In this terminal, type and run yarn dev.

  5. After a while (after all JavaScript and Clojure dependencies are completely downloaded), open localhost:3000 with your web browser.