Build instructions

This article explains how to set up your local development environment so you can contribute to the Portainer codebase.
Make sure you have installed the dependencies for this project on your Mac or Linux machine before continuing.
Windows is currently not supported by the Portainer development environment.
Instructions
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:
1
git clone https://github.com/portainer/portainer.git
Copied!
Next, navigate into the Portainer project you downloaded:
1
cd portainer
Copied!
Install the development dependencies:
1
yarn
Copied!
And finally, build and run the project:
1
yarn start
Copied!
You should now be able to access Portainer at https://localhost:9443.
The frontend application will update when you save your changes to any of the sources. Just refresh the browser to see the changes.
Contribution Guidelines
When contributing to the Portainer codebase, please follow our contribution guidelines.

Contribute to Portainer - Previous

Contribute

Set up a macOS build environment

Last modified 6mo ago

Copy link

Edit on GitHub

Contents

Instructions

Contribution Guidelines