Create the Project

Info: This page describes how to create an empty Bloomreach Content project on your local file system.

Overview

Use a Maven archetype to generate a new Bloomreach Content project. The archetype provides a template with default configuration and structure. When you run the Maven command, it creates a new directory named after your chosen artifactId, containing the generated project files.

On Windows, run the command as a single line. Remove the line continuation characters (\) or use ^ as the continuation character.

Create a Project Using Maven

Bloomreach Content 17

mvn archetype:generate \
-DarchetypeRepository=https://maven.bloomreach.com/repository/maven2-enterprise/ \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-project-archetype \
-DarchetypeVersion=17.2.0

In some cases, you may need to replace archetype:generate with org.apache.maven.plugins:maven-archetype-plugin:3.4.1:generate.

Windows example:

mvn archetype:generate -DarchetypeRepository=https://maven.bloomreach.com/repository/maven2/ -DarchetypeGroupId=org.onehippo.cms7 -DarchetypeArtifactId=hippo-project-archetype -DarchetypeVersion=16.9.4

brXM 16

mvn archetype:generate \
-DarchetypeRepository=https://maven.bloomreach.com/repository/maven2-enterprise/ \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-project-archetype \
-DarchetypeVersion=16.9.4

(Use the same adjustment for Windows as described above.)

brXM 15

mvn archetype:generate \
-DarchetypeRepository=https://maven.bloomreach.com/repository/maven2-enterprise/ \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-project-archetype \
-DarchetypeVersion=15.7.11

(Use the same adjustment for Windows as described above.)

brXM 14

mvn archetype:generate \
-DarchetypeRepository=https://maven.bloomreach.com/repository/maven2-enterprise/ \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-project-archetype \
-DarchetypeVersion=14.7.27

(Use the same adjustment for Windows as described above.)

If your environment uses a proxy, configure the proxy settings in your Maven configuration file. Refer to the Maven Guide to Using Proxies for instructions.

Info: The Maven commands above use the latest Bloomreach Content releases available to standard and premium customers. Before running the command, configure the Bloomreach Content Maven repository.

To use the latest open source release:
Replace the value of -DarchetypeRepository with https://maven.bloomreach.com/repository/maven2/ and set -DarchetypeVersion to the appropriate version number. You can find available versions at https://maven.bloomreach.com/service/rest/repository/browse/maven2/org/onehippo/cms7/hippo-project-archetype/.

Customize Project Properties

The archetype provides default values for all required properties. If you want to change any property, type n when prompted for confirmation and enter your custom values.

You can specify values for these properties:

groupId: The Maven group ID for your project, for example com.mycompany.
artifactId: The main artifact ID for your project. This guide uses myproject as the default.
version: Use the default value unless your project requires a different version. During development, keep -SNAPSHOT in the version string as recommended by Maven best practices.
package name: The Java package for your site application code. The archetype generates the corresponding folder structure. The package name typically matches the Maven groupId.
project name: The name of your project (free text).

Naming guidelines:

Do not use special characters such as dots or dashes in the artifactId.
Avoid using cms or hippo as the artifactId to prevent naming conflicts.
Follow Maven naming conventions: use lowercase letters and avoid special characters.

Project Structure

After you run the Maven command, a new directory is created with the name you specified for artifactId. The generated project includes five modules:

cms: Builds the Bloomreach Content platform web application, including the repository. It uses an embedded, file-based database by default.
cms-dependencies: Contains dependencies for the CMS module.
repository-data: Builds four JAR files with resources for the initial repository content. This includes application data (required for all deployments), development data (for local or CI environments), site configuration, and web files.
site: Builds a JAR with web application components and a WAR for the site web application. The site connects to the platform to render website content.
essentials: Builds the setup web application, which helps you configure and extend your Bloomreach Content project.

Next: Build the Project