Greetings, Java Hipster!
This is the JHipster Angular 2+ utilities library
This library is used by the code generated by the generator-jhipster: https://github.com/jhipster/generator-jhipster/. When releasing a new version of the generator-jhipster then this is tested with the specific version of the ng-jhipster referenced in the generated package.json file. If your application is generated by the older version of the generator-jhipster and you manually update ng-jhipster version in the package.json then this may and may not work. To use a newer version of the ng-jhipster, regenerate application with a newer version of the generator-jhipster which generates a right ng-jhipster version into package.json file.
Full documentation and information is available on our website at https://jhipster.tech/
You need NodeJS and NPM.
Fork the ng-jhipster project
Go to the ng-jhipster project and click on the "fork" button. You can then clone your own fork of the project, and start working on it.
npm install to install all dependencies.
Make some changes, run
npm run test to run both eslint/tslint and unit tests.
Build the library with
npm run build.
Package the library by running
npm pack in the
dist directory. This will create an archive
For testing, you will want to integrate this archive into an application generated by JHipster.
Go to your generated JHipster application and run...
npm install path/to/ng-jhipster/dist/ng-jhipster-vX.Y.Z.tgz
...so that your JHipster application uses the content of this archive as
ng-jhipster dependency which is located in
You can quickly test library changes in Angular application generated by JHipster in the following manner.
Generate Angular application using JHipster generator.
Actions in the
ng-package.dev.jsonchange the value of the
destto some subfolder inside generated project, for example if using Gradle or skipping server then you can use
GeneratedAppRootFolder/build/dist/ng-jhipsterand if using Maven then use
targetsubfolder instead of
For example, if the generated app and the
ng-jhipsterare siblings in the disk then you can use:
One note about this change. As Angular framework architecture excpects that in building app all blocks of the application are inside app root folder then you can't skip this step. If you don't do this change and in the generated app
tsconfig.jsonfile refer to
ng-jhipsterdefault destination folder like this
"ng-jhipster": ["../ng-jhipster/dist"]then runtime errors will occur on running app.
npm run build:dev
Actions in the generated application.
tsconfig.jsonfile, add the following entry into
Optional step. If you are using some other subfolder than
ng-jhipsterbuild destination and this folder is not in
.eslintignorethen add this folder there (this suppresses ESLint errors for compiled
Now on every change in
ng-jhipster the following will happen automatically:
- generated app rebuilds using freshly built local
- generated app is reloaded in the browser and you can see and test changes made in the