This article explains how to set up your local development environment so you can contribute to the Portainer codebase.
Windows is currently not supported by the Portainer development environment.
Navigate to the folder where you will store Portainer project code. This can be anywhere such as on your desktop or in your downloads folder.
Now, download the Portainer project:
git clone https://github.com/portainer/portainer.git
Next, navigate into the Portainer project you downloaded:
Install the development dependencies:
And finally, build and run the project:
You should now be able to access Portainer at
https://localhost:9443and UI dev server runs on
For additional commands, run
The frontend application will update and refresh when you save your changes to any of the sources.