Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.77 KB

setup.md

File metadata and controls

41 lines (30 loc) · 1.77 KB
layout title permalink
page
Setup
/doc/setup/

Quick setup

Use our Maven archetype and modify generated project to your liking (do not forget to replace archetype version with the latest latest version):

mvn archetype:generate -B -DarchetypeGroupId=org.pousse-cafe-framework -DarchetypeArtifactId=pousse-cafe-sample-app-archetype -DarchetypeVersion=$ARCHETYPE_VERSION -DgroupId=test -DartifactId=test -Dversion=0.1.0-SNAPSHOT

Above command creates a folder called test containing a Maven project with all required dependencies to build your first Pousse-Café based application.

Dependencies

Pousse-Café is composed of several Maven modules, allowing developers to include only the ones they need. The modules are available through Maven Central Repository.

To create your first aggregates, you will need at least to depend on the Core module. Add the following snippet to the dependencies of your POM.

<dependency>
  <groupId>org.pousse-cafe-framework</groupId>
  <artifactId>pousse-cafe-core</artifactId>
  <version>${pousse-cafe.version}</version>
</dependency>

To be able to test your code, a dependency to the Test module is also recommended. Add the following snippet to the dependencies of your POM.

<dependency>
  <groupId>org.pousse-cafe-framework</groupId>
  <artifactId>pousse-cafe-test</artifactId>
  <version>${pousse-cafe.version}</version>
  <scope>test</scope>
</dependency>

See Pousse-Café's example project for more details.