Skip to content

Latest commit

 

History

History
283 lines (178 loc) · 9.58 KB

README.md

File metadata and controls

283 lines (178 loc) · 9.58 KB
Raw

eBraire

This application was generated using JHipster 6.10.1, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v6.10.1.

Development

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

  1. 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.


./mvnw


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.

PWA Support

JHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.

The service worker initialization code is commented out by default. To enable it, uncomment the following code in src/main/webapp/index.html:

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

Note: Workbox powers JHipster's service worker. It dynamically generates the service-worker.js file.

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: Edit src/main/webapp/app/vendor.ts file:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/scss/vendor.scss file:

@import '~leaflet/dist/leaflet.css';

Note: There are still a 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.

Using Angular CLI

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate few files:

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

Building for production

Packaging as jar

To build the final jar and optimize the eBraire application for production, run:


./mvnw -Pprod clean verify

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 target/*.jar

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

Refer to Using JHipster in production for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:


./mvnw -Pprod,war clean verify

Testing

To launch your application's tests, run:

./mvnw verify

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

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

You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.

Then, run a Sonar analysis:

./mvnw -Pprod clean verify sonar:sonar

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvnw initialize sonar:sonar

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 postgresql database in a docker container, run:

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

To stop it and remove the container, run:

docker-compose -f src/main/docker/postgresql.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:

./mvnw -Pprod verify jib:dockerBuild

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.

Tests

Gatling

Cette partie se base sur les informations trouvées sur https://www.jhipster.tech/running-tests/ et sur https://gatling.io/docs/current/.

Gatling est un outil destiné à effectuer des tests de performance sur des applications web. Jhipster autogénère des tests Gatling qu'il est possible de modifier pour qu'ils correspondent à notre site de e-commerce. Ces tests sont générés dans src/test/gatling/user-files/simulations.

Pour utiliser Gatling, il faut tout d'abord l'installer via leur page de téléchargement. Pour fonctionner, Gatling a besoin de OpenJDK8 ou OpenJDK11, et de Scala en version 2.12 (Gatling n'est pas compatible avec les versions 2.11 et 2.13).

Une fois installé, il est possible de tester Gatling en exécutant

$GATLING_HOME/bin/gatling.sh

sur Linux/Unix et

%GATLING_HOME%\bin\gatling.bat

sur Windows. Il faut sélectionner une des simulations proposées.

Par défaut, les simulations sont enregistrées dans le dossier $GATLING_HOME/user_files/simulations et les résultats dans $GATLING_HOME/results. Les résultats sont présentés sous forme de fichier html.

Pour exécuter des simulations se trouvant dans un autre répertoire il faut utiliser la commande -sf <path> et pour enregistrer les résultats dans un autre répertoire -rf <path>.

Puisqu'il semble fastidieux d'écrire du code en Scala, Gatling offre un outil permettant de record nos actions sur un site web qui génèrera lui même le code Scala : recorder.

Pour utiliser recorder, il faut exécuter

$GATLING_HOME/bin/recorder.sh

sur Linux/Unix et

%GATLING_HOME%\bin\recorder.bat

sur Windows.

Pour utiliser recorder, il faut configurer le proxy du navigateur utilisé. Pour Firefox, aller dans le menu puis dans préférences. Dans paramètres avancés, aller dans paramètres réseaux et sélectionner la configuration manuelle du proxy avec comme proxy http 127.0.0.1 et comme port 8000, puis cocher "Utiliser également ce proxy pour ftp et https".