Developing ZITADEL with Dev Containers
Dev containers provide a convenient way to set up a development environment for ZITADEL with all the necessary dependencies pre-configured. This allows you to start contributing or working on ZITADEL locally with minimal setup.
Prerequisites​
- Docker installed on your machine. You can find installation instructions for Docker on their official website: https://docs.docker.com/engine/install/
- A code editor or IDE with remote container development capabilities (optional, but recommended). Visual Studio Code with the Remote Containers extension is a popular option.
Setting Up Dev Container​
ZITADEL provides a .devcontainer folder that configures the development environment within a container. Here's how to get started:
- Clone the ZITADEL repository from GitHub:
git clone https://github.com/zitadel/zitadel.git
- Navigate to the project directory:
cd zitadel
- Open the project in your code editor or IDE (if using one with remote container support).
- Follow the instructions provided by your code editor/IDE to initiate the development container. This typically involves opening the "Command Palette" or similar functionality and searching for commands related to "Dev Containers" or "Remote Containers". The quick start guide for VS Code can found here
Note: The first time you run this command, it might take some time to download the container image.
Using Dev Container​
Once the container is running, you will have a development environment set up with all the necessary dependencies pre-installed. You can then follow the instructions in the ZITADEL contribution guide to build and run ZITADEL, or develop the ZITADEL console application.