gatling/README.md

   1 # myapp
   2 This application was generated using JHipster 4.4.1, you can find documentation and help at [https://jhipster.github.io/documentation-archive/v4.4.1](https://jhipster.github.io/documentation-archive/v4.4.1).
   3
   4 ## Development
   5
   6 Before you can build this project, you must install and configure the following dependencies on your machine:
   7
   8 1. [Node.js][]: We use Node to run a development web server and build the project.
   9    Depending on your system, you can install Node either from source or as a pre-packaged bundle.
  10
  11 After installing Node, you should be able to run the following command to install development tools.
  12 You will only need to run this command when dependencies change in [package.json](package.json).
  13
  14     npm install
  15
  16 We use [Gulp][] as our build system. Install the Gulp command-line tool globally with:
  17
  18     npm install -g gulp-cli
  19
  20 Run the following commands in two separate terminals to create a blissful development experience where your browser
  21 auto-refreshes when files change on your hard drive.
  22
  23     ./mvnw
  24     gulp
  25
  26 [Bower][] is used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
  27 specifying a newer version in [bower.json](bower.json). You can also run `bower update` and `bower install` to manage dependencies.
  28 Add the `-h` flag on any command to see how you can use it. For example, `bower update -h`.
  29
  30 For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
  31
  32
  33 ## Building for production
  34
  35 To optimize the myapp application for production, run:
  36
  37     ./mvnw -Pprod clean package
  38
  39 This will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.
  40 To ensure everything worked, run:
  41
  42     java -jar target/*.war
  43
  44 Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
  45
  46 Refer to [Using JHipster in production][] for more details.
  47
  48 ## Testing
  49
  50 To launch your application's tests, run:
  51
  52     ./mvnw clean test
  53
  54 ### Client tests
  55
  56 Unit tests are run by [Karma][] and written with [Jasmine][]. They're located in [src/test/javascript/](src/test/javascript/) and can be run with:
  57
  58     gulp test
  59
  60
  61 ### Other tests
  62
  63 Performance tests are run by [Gatling][] and written in Scala. They're located in [src/test/gatling](src/test/gatling) and can be run with:
  64
  65     ./mvnw gatling:execute
  66
  67 For more information, refer to the [Running tests page][].
  68
  69 ## Using Docker to simplify development (optional)
  70
  71 You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.
  72 For example, to start a mysql database in a docker container, run:
  73
  74     docker-compose -f src/main/docker/mysql.yml up -d
  75
  76 To stop it and remove the container, run:
  77
  78     docker-compose -f src/main/docker/mysql.yml down
  79
  80 You can also fully dockerize your application and all the services that it depends on.
  81 To achieve this, first build a docker image of your app by running:
  82
  83     ./mvnw package -Pprod docker:build
  84
  85 Then run:
  86
  87     docker-compose -f src/main/docker/app.yml up -d
  88
  89 For more information refer to [Using Docker and Docker-Compose][], this page also contains information on the docker-compose sub-generator (`yo jhipster:docker-compose`), which is able to generate docker configurations for one or several JHipster applications.
  90
  91 ## Continuous Integration (optional)
  92
  93 To configure CI for your project, run the ci-cd sub-generator (`yo 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.
  94
  95 [JHipster Homepage and latest documentation]: https://jhipster.github.io
  96 [JHipster 4.4.1 archive]: https://jhipster.github.io/documentation-archive/v4.4.1
  97
  98 [Using JHipster in development]: https://jhipster.github.io/documentation-archive/v4.4.1/development/
  99 [Using Docker and Docker-Compose]: https://jhipster.github.io/documentation-archive/v4.4.1/docker-compose
 100 [Using JHipster in production]: https://jhipster.github.io/documentation-archive/v4.4.1/production/
 101 [Running tests page]: https://jhipster.github.io/documentation-archive/v4.4.1/running-tests/
 102 [Setting up Continuous Integration]: https://jhipster.github.io/documentation-archive/v4.4.1/setting-up-ci/
 103
 104 [Gatling]: http://gatling.io/
 105 [Node.js]: https://nodejs.org/
 106 [Yarn]: https://yarnpkg.org/
 107 [Bower]: http://bower.io/
 108 [Gulp]: http://gulpjs.com/
 109 [BrowserSync]: http://www.browsersync.io/
 110 [Karma]: http://karma-runner.github.io/
 111 [Jasmine]: http://jasmine.github.io/2.0/introduction.html
 112 [Protractor]: https://angular.github.io/protractor/
 113 [Leaflet]: http://leafletjs.com/
 114 [DefinitelyTyped]: http://definitelytyped.org/