Versions Compared

Old Version 17

changes.mady.by.user Kevin Kronenbitter (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Mike Sabatini

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

For iterative development, you may add -Dhelp.skip=true to the build command line. This skips the unpacking and deployment of the help files, significantly reducing the build time. 

Anchor
install_node
install_node
Installing Node

You will want to install both NodeJS and the yarn package manager before building the front end. You can install node by going to the node web page, https://nodejs.org/, and downloading the appropriate installer for your operating system.  On Mac OS X, you can install the Homebrew package manager and install NodeJS and yarn via that. On Linux, NodeJS is usually available via your operating system package manager.

Anchor
install_yarn
install_yarn
Installing Yarn

Yarn is the node package manager that is used within KFS. You can get an installer from its website https://yarnpkg.com/ or use Homebrew on OS X.

Anchor
webpack
webpack
Webpack

Before running Financials, Webpack needs to run to create a file named bundle.js that has all of the React components in it.  When built, this file is located at kfs-web/src/main/webapp/build/bundle.js.  If this isn’t done, the user interface will not render properly.  The maven pom for the kfs-web module of Financials has a step that will download NodeJS, npm yarn and Webpack and build the bundle.js for you.  To do this, run the following maven command:


Code Block
mvn frontend:webpackyarn@yarn-build -pl kfs-web web


If you install NodeJS, npm yarn and Webpack outside of Financials, you can run a Webpack in a mode called “watch”.  This will look for changes to the script files and create the bundle if the files change.  This feature is not available when running maven.  You can install node by going to the node web page, https://nodejs.org/, and downloading the appropriate installer for your operating system.  On Mac OS X, you can install the Homebrew package manager and install NodeJS via that.  On Linux, NodeJS is usually available via your operating system package manager.  Once node Once node and yarn is installed, you can use the node package manager yarn to install webpack.  To do this, follow these steps:

...

Code Block
npm login --registry https://npm.kuali.co
cd kfs-web/src/main/webapp
npmyarn install


This command reads the package.json file in this directory and installs the modules specified into the node_modules folder. 

Warning

The node_modules directory does not get removed during a mvn clean. If there have been significant changes to the npm node dependencies or versions then this can lead to unexpected errors. You can either manually delete the node_modules directory or run 'git clean -df'. After clearing the node_modules directory you will need to run npm yarn install again to re-download the npm node dependencies. (running npm yarn install after deleting node_modules is more time consuming since it has to re-download all of the dependencies instead of just the changed ones)

...

After the webpack module is installed, you can run one of the following commands from inside the webapp directory:


  • npm run yarn watch - This command will build the bundle.js file then monitor the filesystem for changes to the script files.  It will rebuild the bundle.js file if any scripts change.

  • npm run yarn build - This command will build the bundle.js file then exit.  It performs the same work that the maven command performs.

...