Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
PestusAtSAG committed Apr 13, 2020
1 parent 7676bd1 commit f2fc10f
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
## c8y-microservice-archetype
## cumulocity-microservice-archetype

Maven archetype to generate c8y microservice.
Maven archetype to generate cumulocity microservice. Based on https://cumulocity.com/guides/microservice-sdk/java/#java-microservice

The project will contain of:

```console
project
|-- pom.xml
`-- src
|-- main
| | -- java
| | `-- package
| | | -- App.java
| | | -- controller/ExampleController.java
| | `-- service/ExampleService.java
| | -- resources
| | |-- application.properties
| | |-- application-dev.properties
| | |-- application-test.properties
| | |-- application-prod.properties
| | `-- banner.txt
| `-- configuration
| |-- cumulocity.json
| `-- logging.xml
```

## Run

Expand All @@ -16,6 +39,18 @@ Generate C8y miroservice project using interactive mode
mvn archetype:generate -DarchetypeGroupId=cumulocity.microservice -DarchetypeArtifactId=cumulocity-microservice-archetype
```

Running the microservice locally you have to add microservice service user to application-dev.properties

```console
C8Y.bootstrap.tenant=<tenant ID>
C8Y.baseURL=<URL>
C8Y.bootstrap.user=<service-user>
C8Y.bootstrap.password=<service-user-password>
```

Hot to create an application and acquire microservice credentials see also https://cumulocity.com/guides/microservice-sdk/java/#java-microservice


## Authors

[Alexander Pester](mailto:alexander.pester@softwareag.com)
Expand Down

0 comments on commit f2fc10f

Please sign in to comment.