store

This application was generated using JHipster 5.3.4, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.3.4.

Development

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

We use npm scripts and Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./gradlew
npm start

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

Service workers

Service workers are commented by default, to enable them please uncomment the following code.

The service worker registering script in index.html

<script>
    if ('serviceWorker' in navigator) {
        navigator.serviceWorker
        .register('./service-worker.js')
        .then(function() { console.log('Service Worker Registered'); });
    }
</script>

Note: workbox creates the respective service worker and dynamically generate the service-worker.js

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

npm install --save --save-exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

npm install --save-dev --save-exact @types/leaflet

Then you would import the JS and CSS files specified in library's installation instructions so that Webpack knows about them: Note: there are still few other things remaining to do for Leaflet that we won't detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Building for production

To optimize the store application for production, run:

./gradlew -Pprod clean bootWar

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar build/libs/*.war

Then navigate to http://localhost:8080 in your browser.

Refer to Using JHipster in production for more details.

Testing

To launch your application's tests, run:

./gradlew test

Client tests

Unit tests are run by Jest and written with Jasmine. They're located in src/test/javascript/ and can be run with:

npm test

UI end-to-end tests are powered by Protractor, which is built on top of WebDriverJS. They're located in src/test/javascript/e2e and can be run by starting Spring Boot in one terminal (./gradlew bootRun) and running the tests (npm run e2e) in a second one.

For more information, refer to the Running tests page.

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker-compose -f src/main/docker/sonar.yml up -d

Then, run a Sonar analysis:

./gradlew -Pprod clean test sonarqube

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a mysql database in a docker container, run:

docker-compose -f src/main/docker/mysql.yml up -d

To stop it and remove the container, run:

docker-compose -f src/main/docker/mysql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

./gradlew bootWar -Pprod buildDocker

Then run:

docker-compose -f src/main/docker/app.yml up -d

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

XL Platform deployment

The application is deployed to AWS ECS using XL Deploy. The deployment template is found under ./xl-platform/xld-ecs-*.yml

The deployment architecture is as below

To apply the templates run

xl apply -f xl-platform/xld-ecs-infrastructure.yml
xl apply -f xl-platform/xld-ecs-service.yml

Go to XL Deploy and deploy the infrastructure followed by the service

Run the e-Commerce monolith demo with Service Catalog

N.B. 1: The scenario will only run in eu-west-1 because the Service Catalog product it needs was only created there. N.B. 2: The scenario requires credentials with admin privileges in AWS.

Check out branch devops-as-code-workshop-3 from the devops-as-code-workshop repo
Install the XL CLI as described in the README for the workshop
Run the XL DevOps Platform with Docker Compose as described in the README for the workshop
Apply the following files from this repo:
- xebialabs/service-catalogue/ecommerce-monolith-pipeline.xl.yaml
- xebialabs/service-catalogue/ecommerce-monolith-application.xl.yaml
In XL Deploy, set the access key ID and secret acces key for the Infrastructure/AWS CI
Run "Check connection" on the Infrastructure/AWS CI
Create and start a release from the e-commerce template in the folder called E-COMMERCE
- Sometimes the "Undeploy e-commerce application" task will get stuck. In that case, log in to the ECS console, select the ECS cluster ecommerceMonolithCluster, go to the Tasks section and stop the task that are still running.

JHipster generated kubernetes configuration

Preparation

You will need to push your image to a registry. If you have not done so, use the following commands to tag and push the images:

$ docker image tag store xebialabsunsupported/store
$ docker push xebialabsunsupported/store

Deployment

You can deploy all your apps by running the below bash command:

./kubectl-apply.sh

xebialabs/e-commerce-monolith