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

Build Portainer locally


Ensure you have Docker, Node.js >= 0.8.4 and npm installed locally.


Checkout the project and go inside the root directory:

$ git checkout
$ cd portainer

Install the dependencies using npm:

$ npm install

Start a live-reload process, the local application will be updated when you save your changes:

$ grunt run-dev

Access Portainer at http://localhost:9000

Do not forget to lint your code:

$ grunt lint

Contribution guidelines

Please follow the contribution guidelines on the repository.