Contribute¶
Use the following instructions and guidelines to contribute to the Portainer project.
Build Portainer locally¶
Requirements¶
Ensure you have Docker, Node.js >= 6, yarn and Golang (>= 1.11) installed on your system.
Build¶
Checkout the project, set up the project inside your $GOPATH
and go inside the root directory:
$ git clone https://github.com/portainer/portainer.git
$ mkdir -p ${GOPATH}/src/github.com/portainer
$ ln -s ${PWD}/portainer ${GOPATH}/src/github.com/portainer/portainer
$ cd portainer
Install dependencies with yarn:
$ yarn
Build and run the project:
$ 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.
Contribution guidelines¶
Please follow the contribution guidelines on the repository.
Contributing to the documentation¶
Checkout the project and go inside the root directory:
$ git clone https://github.com/portainer/portainer-docs.git
$ cd portainer-docs
Update the documentation and trigger a local build:
$ docker run --rm -v ${PWD}/docs:/src portainer/docbuilder:latest make html
This will create a local folder docs/build/html
where you will find the generated static files for the documentation.