Skip to content

Commit

Permalink
Updated groupId and README
Browse files Browse the repository at this point in the history
  • Loading branch information
rijnb committed Sep 30, 2020
1 parent e466f33 commit 7c1990e
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 20 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,24 +141,25 @@ To build the WAR file, type
cd <project-root>
mvn clean install -Pprod

You can run the WAR file in 3 ways:
This will install the required JAR files in your local Maven repository (normally
at `~/.m2/repository`). You can run the WAR file in 3 ways:

1. directly from the **command-line**, using:

```
java -jar deployment/target/deployment-<version>.war [--port <port>] [--silent] [--debug] [--help]
```

This will start the service at `http://localhost:<port>/mapcode`. If `<port>` is not specified, the
default value is `8080`. If it is `0`, the server will choose any free port.

2. directly from **Maven** using:
1. Directly from **Maven** using:

```
cd deployment
mvn jetty:run
```

2. Or directly from the **command-line**, using:

```
java -jar deployment/target/deployment-<version>.war [--port <port>] [--silent] [--debug] [--help]
```

This will start the service at `http://localhost:<port>/mapcode`. If `<port>` is not specified, the
default value is `8080`. If it is `0`, the server will choose any free port.

This will start the service at `http://localhost:8080/mapcode`.

3. in a **Tomcat server**, deploying the file `deployment/target/deployment-<version>.war` into
Expand All @@ -167,6 +168,9 @@ your Tomcat instance.
The first method, running the WAR file from the command-line, using `java` only is particularly
useful if you wish use the XML services, for example, in a Microsoft Excel spreadsheet.

**Important:** If the service does not start, some files may be missing from your `external-resources`
directory. To fix this, read on.

### Missing `mapcode-secret.properties` and `log4j.xml` Files

The service requires 2 files called `mapcode-secret.properties` and `log4j.xml` to be present on the
Expand Down Expand Up @@ -351,6 +355,12 @@ self-hosting this service.

## Release Notes

### 2.4.14.4

* Changed `groupId` to `com.mapcode.rest`.

* Updated `README.md` with correct instructions to create WAR file.

### 2.4.14.3

* Updated dependencies.
Expand Down
4 changes: 2 additions & 2 deletions deployment/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.mapcode</groupId>
<groupId>com.mapcode.rest</groupId>
<artifactId>mapcode-rest-service</artifactId>
<version>2.4.14.3</version>
<version>2.4.14.4</version>
</parent>

<artifactId>deployment</artifactId>
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.mapcode</groupId>
<groupId>com.mapcode.rest</groupId>
<artifactId>mapcode-rest-service</artifactId>

<packaging>pom</packaging>
<version>2.4.14.3</version>
<version>2.4.14.4</version>

<name>Mapcode REST API Web Service</name>
<description>
Expand Down
4 changes: 2 additions & 2 deletions resources/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.mapcode</groupId>
<groupId>com.mapcode.rest</groupId>
<artifactId>mapcode-rest-service</artifactId>
<version>2.4.14.3</version>
<version>2.4.14.4</version>
</parent>

<artifactId>resources</artifactId>
Expand Down
4 changes: 2 additions & 2 deletions service/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>com.mapcode</groupId>
<groupId>com.mapcode.rest</groupId>
<artifactId>mapcode-rest-service</artifactId>
<version>2.4.14.3</version>
<version>2.4.14.4</version>
</parent>

<artifactId>service</artifactId>
Expand Down

0 comments on commit 7c1990e

Please sign in to comment.