Home

This wiki holds the documentation for the Liferay npm Build Tools (aka npm SDK).

👀 Unless otherwise stated, all tools work for ANY version of Liferay starting from 7.0.

👀 Please note that currently, there are two version lines for the npm SDK known as 1.x and 2.x. The former one (1.x) is discouraged, as it has some drawbacks in its design that prevents it from fulfilling all developer needs, so we encourage you to switch to 2.x as soon as possible to avoid problems. Follow this link to get more information on how to perform that task.

You can file any bug related to this project in the issues page.

You can also get information about released versions and their changes in the closed milestones page.

And if you want to know what's planned for the next version, just visit the open milestones page.

Now, let's go with the documentation:

1. Most usual tasks:

   1. How to create pure Javascript projects
      1. How to configure Liferay features in pure Javascript projects
   2. How to create mixed Java/Javascript projects

2. More esoteric tasks:

   1. Migrating bundler from 1.x to 2.x

3. Low level (platform architecture) topics:

   1. How to deploy npm packages to Liferay
   2. How Liferay serves npm packages to the browser

4. Tool manuals:

   1. How to use liferay-npm-bundler
   2. How to use liferay-npm-bridge-generator
   3. How to use liferay-npm-imports-checker
   4. How to use generator-liferay-bundle

5. Reference

   1. .npmbundlerrc file reference
   2. JS-extended portlets entry point
   3. configuration.json file reference

6. Other sources of documentation:

   1. Liferay Documentation
   2. Liferay Forums
   3. Liferay Community Slack
   4. Question issues
   5. Miscellaneous resources