Creating an application

Please check our video tutorial on creating a new JHipster application!

1. Quick start
2. Questions asked when generating an application
3. Command-line options
4. Tips

Quick start

First of all, create an empty directory in which you will create your application:

mkdir myapplication

Go to that directory:

cd myapplication/

To generate your application, type:

yo jhipster

Answer the questions asked by the generator to create an application tailored to your needs. Those options are described in the next section.

Once the application is generated, you can launch it using Maven (./mvnw on Linux/MacOS/Windows PowerShell, mvnw on Windows Cmd) or Gradle (./gradlew on Linux/MacOS/Windows PowerShell, gradlew on Windows Cmd).

The application will be available on http://localhost:8080

Important if you want to have “live reload” of your JavaScript/TypeScript code, you will need run gulp (for JavaScript/AngularJS 1) or yarn start (for TypeScript/Angular 2+). You can go to the Using JHipster in development page for more information.

Questions asked when generating an application

Some questions change depending on the previous choices you have made. For example, you won’t need to configure an Hibernate cache if you didn’t select an SQL database.

Which type of application would you like to create?

Your type of application depends on whether you wish to use a microservices architecture or not. A full explanation on microservices is available here, if unsure use the default “Monolithic application”.

You can either use:

• Monolithic application: this a classical, one-size-fits-all application. It’s easier to use and develop, and is our recommended default.
• Microservice application: in a microservices architecture, this is one of the services.
• Microservice gateway: in a microservices architecture, this is an edge server that routes and secures requests.
• JHipster UAA server [BETA]: in a microservices architecture, this is an OAuth2 authentication server that secures microservices. Refer JHipster UAA documentation for more information.

What is the base name of your application?

This is the name of your application.

Would you like to install other generators from the JHipster Marketplace?

The JHipster Marketplace is where you can install additional modules, written by third-party developers, to add non-official features to your project.

What is your default Java package name?

Your Java application will use this as its root package. This value is stored by Yeoman so that the next time you run the generator the last value will become default. Of course you can override it by providing a new value.

Do you want to use the JHipster Registry to configure, monitor and scale your application?

The JHipster Registry is an Open Source tool used to manage your application at runtime.

It is required when using a microservices architecture (this is why this question is only asked when generating a monolith).

Which type of authentication would you like to use?

This question won’t be asked if you selected the JHipster Registry, as it requires the use of JWT authentication.

You can either use:

• JSON Web Token (JWT), which is the default choice
• A classical session-based authentication mechanism, like we are used to do in Java (this is how most people use Spring Security). You can use this option with Spring Social, which will enable you to use “social login” (such as Google, Facebook, Twitter): this is configured by Spring Boot’s support of Spring Social.
• An OAuth 2.0 authentication mechanism (JHipster then provides the necessary OAuth2 server code and database tables).

The OAuth 2.0 and the JWT approaches allow to use a stateless application architecture (they do not rely on the HTTP Session). You can find more information on our securing your application page.

Which type of database would you like to use?

You can choose between:

• No database (only available when using a microservice application)
• An SQL database (H2, MySQL, MariaDB, PostgreSQL, MSSQL, Oracle), which you will access with Spring Data JPA
• MongoDB
• Cassandra

Which production database would you like to use?

This is the database you will use with your “production” profile. To configure it, please modify your src/main/resources/config/application-prod.yml file.

If you want to use Oracle, you will need to install the Oracle JDBC driver manually.

Which development database would you like to use?

This is the database you will use with your “development” profile. You can either use:

• H2, running in-memory. This is the easiest way to use JHipster, but your data will be lost when you restart your server.
• H2, with its data stored on disk. This is currently in BETA test (and not working on Windows), but this would eventually be a better option than running in-memory, as you won’t lose your data upon application restart.
• The same database as the one you chose for production: it’s a bit more complex to set up, but it should be better in the end to work on the same database as the one you will use in production. This is also the best way to use liquibase-hibernate as described in the development guide.

To configure it, please modify your src/main/resources/config/application-dev.yml file.

Do you want to use Hibernate 2nd level cache?

Hibernate is the JPA provider used by JHipster. For performance reasons, we highly recommend you to use a cache, and to tune it according to your application’s needs. If you choose to do so, you can use either ehcache (local cache) or Hazelcast (distributed cache, for use in a clustered environnement)

Would you like to use Maven or Gradle?

You can build your generated Java application either with Maven or Gradle. Maven is more stable and more mature. Gradle is more flexible, easier to extend, and more hype.

Which other technologies would you like to use?

This is a multi-select answer, to add one or several other technologies to the application. Available technologies are:

Social login (Google, Facebook, Twitter)

This option is only available if you selected an SQL database or a MongoDB database. It adds Spring Social support to JHipster, so end-users can log-in using their Google, Facebook or Twitter account.

Search engine using ElasticSearch

Elasticsearch will be configured using Spring Data Elasticsearch. You can find more information on our Elasticsearch guide.

Clustered HTTP sessions using Hazelcast

By default, JHipster uses a HTTP session only for storing Spring Security’s authentication and authorisation information. Of course, you can choose to put more data in your HTTP sessions. Using HTTP sessions will cause issues if you are running in a cluster, especially if you don’t use a load balancer with “sticky sessions”. If you want to replicate your sessions inside your cluster, choose this option to have Hazelcast configured.

WebSockets using Spring Websocket

Websockets can be enabled using Spring Websocket. We also provide a complete sample to show you how to use the framework efficiently.

Asynchronous messages using Apache Kafka

Use Apache Kafka as a publish/subscribe message broker.

Which Framework would you like to use for the client?

The client side framework to use.

You can either use:

• AngularJS version 1.x
• Angular version 2+ [BETA]

Please note that Angular 2+ support is currently in BETA and hence may not be suitable for production use.

Would you like to use the LibSass stylesheet preprocessor for your CSS?

Node-sass a great solution to simplify designing CSS. To be used efficiently, you will need to run a Gulp server, which will be configured automatically.

Would you like to enable translation support with Angular Translate?

By default JHipster provides excellent internationalization support, both on the client side and on the server side. However, internationalization adds a little overhead, and is a little bit more complex to manage, so you can choose not to install this feature.

Which testing frameworks would you like to use?

By default JHipster provide Java unit/integration testing (using Spring’s JUnit support) and JavaScript unit testing (using Karma.js). As an option, you can also add support for:

• Performance tests using Gatling
• Behaviour tests using Cucumber
• Angular integration tests with Protractor

You can find more information on our “Running tests” guide.

Command-line options

You can also run JHipster with some optional command-line options. Reference for those options can be found by typing yo jhipster --help.

Here are the options you can pass:

• --help - Print the generator’s options and usage
• --skip-cache - Do not remember prompt answers (Default: false)
• --skip-install - Do not automatically install dependencies (Default: false)
• --skip-client - Skip the client-side application generation, so you only have the Spring Boot back-end code generated (Default: false). This is same as running server sub-generator with yo jhipster:server.
• --skip-server - Skip the server-side application generation, so you only have the front-end code generated (Default: false). This is same as running client sub-generator with yo jhipster:client.
• --skip-user-management - Skip the user management generation, both on the back-end and on the front-end (Default: false)
• --i18n - Disable or enable i18n when skipping client side generation, has no effect otherwise (Default: true)
• --with-entities - Regenerate the existing entities if they were already generated (using their configuration in the .jhipster folder) (Default: false)
• --skip-checks - Skip the check of the required tools (Default: false)
• --jhi-prefix - Add prefix before services, components and state/route names (Default: jhi)
• --npm - Use NPM instead of Yarn (Default: false)

Tips

If you are an advanced user you can use our client and server sub-generators by running yo jhipster:client --[options] and yo jhipster:server --[options]. Run the above sub-generators with --help flag to view all the options that can be passed.

You can also use the Yeoman command-line options, like --force to automatically overwrite existing files. So if you want to regenerate your whole application, including its entities, you can run yo jhipster --force --with-entities.