Building From Source

How to build from source and contribute

To begin with, thank you for your consideration to contribute to PrimeNG.

PrimeNG package.json configuration is in distribution mode by default, meaning there are no dependencies defined to run the samples. To build PrimeNG from source and run the showcase locally, follow the instructions below;

Fork and Clone the Repository

Your clone has a package.json at the root folder, remove the peerDependencies section and replace it with the following so that the npm can download the required dependencies to run the showcase.

  "dependencies": {
      "@angular/common":  "2.0.0-rc.3",
      "@angular/compiler":  "2.0.0-rc.3",
      "@angular/core":  "2.0.0-rc.3",
      "@angular/forms": "0.1.1",
      "@angular/http":  "2.0.0-rc.3",
      "@angular/platform-browser":  "2.0.0-rc.3",
      "@angular/platform-browser-dynamic":  "2.0.0-rc.3",
      "@angular/router":  "3.0.0-alpha.6",
      "@angular/router-deprecated":  "2.0.0-rc.3",
      "@angular/upgrade":  "2.0.0-rc.3",
      "systemjs": "0.19.31",
      "core-js": "^2.4.0",
      "reflect-metadata": "^0.1.3",
      "rxjs": "5.0.0-beta.6",
      "zone.js": "^0.6.12",
      "angular2-in-memory-web-api": "0.0.7",
      "primeui": "^4.1.12"
  },

Then run the following commands in order;

• npm install
• typings install
• npm start

A browser window will popup and runs the showcase at http://localhost:3000. After this stage, you may revert the change in package.json above to its original state as it will still run perfectly.

Now you'll be able to make changes to PrimeNG components and hopefully provide pull requests to contribute.