Playground: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 45: Line 45:
===Multi-Module Project===
===Multi-Module Project===


For a multi-module project, add the following module section and the corresponding [[Multi-Module_Maven_Projects#The_Module_POM|sub-module pom.xml]]s.
For a multi-module project, add the following module section to the root pom:


<pre>
<pre>
Line 56: Line 56:
   </modules>
   </modules>
</pre>
</pre>
... and the corresponding [[Multi-Module_Maven_Projects#The_Module_POM|sub-module pom.xml]]s.


==3. Create the IntelliJ project==
==3. Create the IntelliJ project==

Revision as of 23:53, 27 February 2017

Reference Assets

Reference operations script: playground/project-template/bin/operations. Works with local and remote servers.

New Project

Use the playground project template:

https://github.com/NovaOrdis/playground/tree/master/project-template

This template contains a basic structure and artifacts to be used when starting new playground project. In order to create a new project:

1. Recursively copy the template under a new name, and customize it

cp -r .../project-template .../<your-project-name>
cd .../<your-project-name>
rm -r .idea

2. Edit pom.xml

name

groupId

The Maven group should follow the playground directory structure:

    <groupId>io.novaordis.playground.wildfly.hornetq</groupId>

artifactId

Example:

    <artifactId>simple-hornetq-client</artifactId>

This will become the IntelliJ project name.

finalName

Multi-Module Project

For a multi-module project, add the following module section to the root pom:

   ...
   <artifactId>root</artifactId>
   <packaging>pom</packaging>
   ...
   <modules>
      <module>...</module>
   </modules>

... and the corresponding sub-module pom.xmls.

3. Create the IntelliJ project

Import Project from Maven.

Keep project files in .../.idea.

4. Edit README.md

By default, README contains generic content.

It may be changed to contain a link to NOKB page about the subject.

Operations

Run Locally

Use:

./bin/run

The script will assemble the classpath automatically and will attempt to guess the main class.

Deployment/Undeployment

deploy --help
undeploy --help