Skip to content

Commit

Permalink
chore(webapps): update Readme and comments
Browse files Browse the repository at this point in the history
related to: #4549
  • Loading branch information
venetrius committed Oct 22, 2024
1 parent e040dc3 commit bace476
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
19 changes: 13 additions & 6 deletions webapps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,18 +92,25 @@ mvn jetty:run -Pdevelop
npm run start
```

#### AngularJS libraries from XLTS.dev
#### Never Ending Support libraries from Hero Devs

Since December 31, 2021, AngularJS is no longer officially supported by the original maintainers (Google). We replaced the official AngularJS libraries with the ones from [XLTS.dev](https://XLTS.dev) to ensure that our used libraries stay secure and supported. We include the AngularJS libraries from XLTS.dev in our Community Edition releases from 7.18.0-alpha2 on.
##### AngularJS
Since December 31, 2021, AngularJS is no longer officially supported by the original maintainers (Google). We replaced the official AngularJS libraries with the ones from [herodevs](https://www.herodevs.com/) to ensure that our used libraries stay secure and supported. We include the AngularJS libraries from herodevs in our Community Edition releases from 7.18.0-alpha2 on.

**Heads-up:** If you build the Webapps from source code, the build includes the no longer maintained AngularJS libraries in version 1.8.2 unless you have access to the XLTS.dev registry and configure it as shown below.
**Heads-up:** If you build the Webapps from source code, the build includes the no longer maintained AngularJS libraries in version 1.8.2 unless you have access to the herodevs registry and configure it as shown below.

To enable pulling the XLTS.dev AngularJS libraries while building the Webapps, please configure the npm registry. Add the XLTS.dev npm registry by replacing the variables `${XLTS_REGISTRY}` and `${XLTS_AUTH_TOKEN}` in the following commands and execute the commands in your terminal.
##### Bootstrap
Since December 31, 2021, the legacy Bootstrap 3 library is no longer officially supported by the original maintainers (twbs Bootstrap). We replaced the official Bootstrap 3 libraries with the ones from [herodevs](https://www.herodevs.com/) to ensure that our used libraries stay secure and supported. We include the Bootstrap 3 libraries from herodevs in our Community Edition releases from 7.23.0-alpha1 on.

Commands to configure the XLTS.dev npm registry:
**Heads-up:** If you build the Webapps from source code, the build includes the no longer maintained Bootstrap 3 libraries in version 3.4.1 unless you have access to the herodevs registry and configure it as shown below.

##### Configure the herodevs registry
To enable pulling the HeroDevs AngularJS and Bootstrap libraries while building the Webapps, please configure the npm registry. Add the HeroDevs npm registry by replacing the variables `${XLTS_REGISTRY}` and `${XLTS_AUTH_TOKEN}` in the following commands and execute the commands in your terminal.

Commands to configure the herodevs npm registry:

```
npm set @xlts.dev:registry https://${XLTS_REGISTRY}/
npm set @neverendingsupport:registry=https://${XLTS_REGISTRY}/
npm set //${XLTS_REGISTRY}/:_authToken ${XLTS_AUTH_TOKEN}
```

Expand Down
4 changes: 2 additions & 2 deletions webapps/frontend/scripts/xlts.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,12 @@ const {XLTS_REGISTRY, XLTS_AUTH_TOKEN} = process.env;
if (!registryConfigured && XLTS_REGISTRY && XLTS_AUTH_TOKEN) {
exec(
`npm set @${scope}:registry https://${XLTS_REGISTRY}`,
'XLTS.dev registry configured.'
'XLTS registry configured.'
);

exec(
`npm set //${XLTS_REGISTRY}:_authToken ${XLTS_AUTH_TOKEN}`,
'XLTS.dev auth token configured.'
'XLTS auth token configured.'
);
}

Expand Down
2 changes: 1 addition & 1 deletion webapps/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@
</configuration>
</execution>
<execution>
<id>Install XLTS.dev dependencies</id>
<id>Install heroDev XLTS dependencies</id>
<goals>
<goal>npm</goal>
</goals>
Expand Down

0 comments on commit bace476

Please sign in to comment.