Skip to content

Commit 76b28a8

Browse files
committed
update install instructions to cover installation of pro Font Awesome icons (and what happens if you don't)
1 parent 4a6ae71 commit 76b28a8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,22 @@ In your terminal, execute the following command:
143143
This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.
144144
This folder does not get included in the UI bundle and should _not_ be committed to the source control repository.
145145

146+
In order for the pro Font Awesome icons work, you must first add the following file to the root folder of the UI project:
147+
148+
..npmrc
149+
----
150+
@fortawesome:registry=https://npm.fontawesome.com/
151+
//npm.fontawesome.com/:_authToken=${FONTAWESOME_NPM_AUTH_TOKEN}
152+
----
153+
154+
Then pass the token to npm when running the `npm install` command:
155+
156+
FONTAWESOME_NPM_AUTH_TOKEN=xxxx npm install
157+
158+
If you don't supply this token when installing packages, the pro icons will not be installed, but the UI preview will still work.
159+
Any icon available in the free collection will still be found, but the pro icons will be missing.
160+
When an icon is missing, a missing icon is shown instead.
161+
146162
=== Preview the UI
147163

148164
The UI project is configured to preview offline.

0 commit comments

Comments
 (0)