Download the UI source
To customize the layout and functionality of the UI, you must download, rebuild, and deploy the UI project. The build process for the UI uses the Webpack resource bundler to manage dependencies, optimize deliverables, and package the output.
ForgeRock provides the source code for the UI as a Maven project in the am-external public GitHub repository.
Follow these steps to get the UI source code:
-
Clone the
am-external
repository:$ git clone https://github.com/ForgeRock/am-external.git
-
Check out the
releases/7.5.0
branch:$ cd am-external $ git checkout releases/7.5.0
The End User UI project is in the
am-external/openam-ui
folder. -
If you don’t already have them, install the following prerequisites:
For information on building the UI as part of a Maven workflow for deployment inside a WAR file, refer to How do I customize the XUI using source code in PingAM?.
-
Use the
yarn
command to download the dependencies to the project:$ cd openam-ui/openam-ui-user $ yarn install [1/4] 🔍 Resolving packages… [2/4] 🚚 Fetching packages… [3/4] 🔗 Linking dependencies… [4/4] 📃 Building fresh packages… ✨ Done in 9.08s.
In some environments you might receive an error such as
gyp ERR! not ok
when downloading dependencies.You can ignore such errors as they apply only to optional components in certain environments. You can also use the
yarn install --ignore-optional
command to suppress these errors.