Repository files navigation

This application was generated using JHipster 3.12.2, you can find documentation and help athttps://jhipster.github.io/documentation-archive/v3.12.2.

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 (likeBower andBrowserSync). You will only need to run this command when dependencies change in package.json.

npm install

We useGulp as our build system. Install the Gulp command-line tool globally with:

npm install -g gulp-cli

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

./gradlewgulp

Bower is used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies byspecifying a newer version inbower.json. You can also runbower update andbower install to manage dependencies.Add the-h flag on any command to see how you can use it. For example,bower update -h.

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

To optimize the Bookstore application for production, run:

./gradlew -Pprod clean bootRepackage

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

java -jar build/libs/*.war

Then navigate tohttp://localhost:8080 in your browser.

Refer toUsing JHipster in production for more details.

To launch your application's tests, run:

./gradlew test

Unit tests are run byKarma and written withJasmine. They're located insrc/test/javascript/ and can be run with:

gulp test

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

For more information, refer to theRunning tests page.

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in thesrc/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 bootRepackage -Pprod buildDocker

Then run:

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

For more information refer toUsing 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.

To set up a CI environment, consult theSetting up Continuous Integration page.