Contribute

Use the following instructions and guidelines to contribute to the Portainer project.

Build Portainer locally

Requirements

Ensure you have Docker, Node.js >= 6, and yarn.

Build

Checkout the project and go inside the root directory:

$ git clone https://github.com/portainer/portainer.git
$ cd portainer

Install dependencies with yarn:

$ yarn

Build the app locally:

$ yarn build

Start a watched build process:

$ yarn start

Access Portainer at http://localhost:9000

Tip

The frontend application will be updated when you save your changes to any of the sources (app/**/*.js, assets/css/app.css or index.html). Just refresh the browser.

Important

Do not forget to lint your code:

$ yarn grunt lint

Contribution guidelines

Please follow the contribution guidelines on the repository.